diff --git a/app/caches.py b/app/caches.py index df95f508..9e25aeac 100644 --- a/app/caches.py +++ b/app/caches.py @@ -49,4 +49,4 @@ async def load_cache(data_id: str, data, namespace: str = None, cache_life: int cache = get_cache(namespace) await cache.set(data_id, data, ttl=cache_life) LOGGER.info(f"{data_id} cache loaded") - await cache.close() + await cache.close() \ No newline at end of file diff --git a/app/coordinates.py b/app/coordinates.py index be972c6e..1fb9f08a 100644 --- a/app/coordinates.py +++ b/app/coordinates.py @@ -1,5 +1,5 @@ """app.coordinates.py""" - +from abc import abstractmethod, ABCMeta class Coordinates: """ @@ -21,3 +21,5 @@ def serialize(self): def __str__(self): return "lat: %s, long: %s" % (self.latitude, self.longitude) + + diff --git a/app/data/__init__.py b/app/data/__init__.py index 60a75dac..d29f30e8 100644 --- a/app/data/__init__.py +++ b/app/data/__init__.py @@ -2,12 +2,16 @@ from ..services.location.csbs import CSBSLocationService from ..services.location.jhu import JhuLocationService from ..services.location.nyt import NYTLocationService +from ..services.location import LocationServiceAbstractionImpl + + + # Mapping of services to data-sources. DATA_SOURCES = { - "jhu": JhuLocationService(), - "csbs": CSBSLocationService(), - "nyt": NYTLocationService(), + "jhu": LocationServiceAbstractionImpl(JhuLocationService()), + "csbs": LocationServiceAbstractionImpl(CSBSLocationService()), + "nyt": LocationServiceAbstractionImpl(NYTLocationService()), } diff --git a/app/io.py b/app/io.py index 2a563b15..3c5bfc2f 100644 --- a/app/io.py +++ b/app/io.py @@ -1,4 +1,5 @@ """app.io.py""" +from abc import ABCMeta, abstractmethod import json import pathlib from typing import Dict, List, Union diff --git a/app/services/location/__init__.py b/app/services/location/__init__.py index 6d292b54..03686b9e 100644 --- a/app/services/location/__init__.py +++ b/app/services/location/__init__.py @@ -1,6 +1,5 @@ """app.services.location""" -from abc import ABC, abstractmethod - +from abc import ABC, abstractmethod, abstractstaticmethod class LocationService(ABC): """ @@ -26,3 +25,61 @@ async def get(self, id): # pylint: disable=redefined-builtin,invalid-name :rtype: Location """ raise NotImplementedError + + + +''' +This is the interface for the client to interact with in order to handle the calls +''' +class LocationServiceAbstraction(ABC): + """ + Service for retrieving locations. + """ + + @abstractmethod + async def get_all(self): + """ + Gets and returns all of the locations. + + :returns: The locations. + :rtype: List[Location] + """ + raise NotImplementedError + + @abstractmethod + async def get(self, id): # pylint: disable=redefined-builtin,invalid-name + """ + Gets and returns location with the provided id. + + :returns: The location. + :rtype: Location + """ + raise NotImplementedError + + +''' +This is the implementation that the client will interact with in order to execute the required locationservice implementation +''' +class LocationServiceAbstractionImpl(LocationServiceAbstraction): + def __init__(self, implementation): + self.__provider = implementation + + async def get_all(self): + return await self.__provider.get_locations() + + async def get(self, id): + return await self.__provider.get(id) + + +''' +interface for all location services to implement in order to satisfy consistency with each type of locationservice alongside the bridge pattern +''' +class ILocationService(ABC): + @abstractmethod + async def get_locations(self): + return NotImplementedError + + @abstractmethod + async def get(self, id): + return NotImplementedError + diff --git a/app/services/location/csbs.py b/app/services/location/csbs.py index 444ebad6..387fe37f 100644 --- a/app/services/location/csbs.py +++ b/app/services/location/csbs.py @@ -10,93 +10,86 @@ from ...coordinates import Coordinates from ...location.csbs import CSBSLocation from ...utils import httputils -from . import LocationService +from . import ILocationService LOGGER = logging.getLogger("services.location.csbs") +# Base URL for fetching data -class CSBSLocationService(LocationService): +class CSBSLocationService(ILocationService): """ Service for retrieving locations from csbs """ - - async def get_all(self): - # Get the locations. - locations = await get_locations() + def __init__(self): + self.BASE_URL = "https://facts.csbs.org/covid-19/covid19_county.csv" + + @cached(cache=TTLCache(maxsize=1, ttl=1800)) + async def get_locations(self): + """ + Retrieves county locations; locations are cached for 1 hour + + :returns: The locations. + :rtype: dict + """ + data_id = "csbs.locations" + LOGGER.info(f"{data_id} Requesting data...") + # check shared cache + cache_results = await check_cache(data_id) + if cache_results: + LOGGER.info(f"{data_id} using shared cache results") + locations = cache_results + else: + LOGGER.info(f"{data_id} shared cache empty") + async with httputils.CLIENT_SESSION.get(self.BASE_URL) as response: + text = await response.text() + + LOGGER.debug(f"{data_id} Data received") + + data = list(csv.DictReader(text.splitlines())) + LOGGER.debug(f"{data_id} CSV parsed") + + locations = [] + + for i, item in enumerate(data): + # General info. + state = item["State Name"] + county = item["County Name"] + + # Ensure country is specified. + if county in {"Unassigned", "Unknown"}: + continue + + # Date string without "EDT" at end. + last_update = " ".join(item["Last Update"].split(" ")[0:2]) + + # Append to locations. + locations.append( + CSBSLocation( + # General info. + i, + state, + county, + # Coordinates. + Coordinates(item["Latitude"], item["Longitude"]), + # Last update (parse as ISO). + datetime.strptime(last_update, "%Y-%m-%d %H:%M").isoformat() + "Z", + # Statistics. + int(item["Confirmed"] or 0), + int(item["Death"] or 0), + ) + ) + LOGGER.info(f"{data_id} Data normalized") + # save the results to distributed cache + # TODO: fix json serialization + try: + await load_cache(data_id, locations) + except TypeError as type_err: + LOGGER.error(type_err) + + # Return the locations. return locations + + async def get(): + return NotImplementedError - async def get(self, loc_id): # pylint: disable=arguments-differ - # Get location at the index equal to the provided id. - locations = await self.get_all() - return locations[loc_id] - - -# Base URL for fetching data -BASE_URL = "https://facts.csbs.org/covid-19/covid19_county.csv" - -@cached(cache=TTLCache(maxsize=1, ttl=1800)) -async def get_locations(): - """ - Retrieves county locations; locations are cached for 1 hour - - :returns: The locations. - :rtype: dict - """ - data_id = "csbs.locations" - LOGGER.info(f"{data_id} Requesting data...") - # check shared cache - cache_results = await check_cache(data_id) - if cache_results: - LOGGER.info(f"{data_id} using shared cache results") - locations = cache_results - else: - LOGGER.info(f"{data_id} shared cache empty") - async with httputils.CLIENT_SESSION.get(BASE_URL) as response: - text = await response.text() - - LOGGER.debug(f"{data_id} Data received") - - data = list(csv.DictReader(text.splitlines())) - LOGGER.debug(f"{data_id} CSV parsed") - - locations = [] - - for i, item in enumerate(data): - # General info. - state = item["State Name"] - county = item["County Name"] - - # Ensure country is specified. - if county in {"Unassigned", "Unknown"}: - continue - - # Date string without "EDT" at end. - last_update = " ".join(item["Last Update"].split(" ")[0:2]) - - # Append to locations. - locations.append( - CSBSLocation( - # General info. - i, - state, - county, - # Coordinates. - Coordinates(item["Latitude"], item["Longitude"]), - # Last update (parse as ISO). - datetime.strptime(last_update, "%Y-%m-%d %H:%M").isoformat() + "Z", - # Statistics. - int(item["Confirmed"] or 0), - int(item["Death"] or 0), - ) - ) - LOGGER.info(f"{data_id} Data normalized") - # save the results to distributed cache - # TODO: fix json serialization - try: - await load_cache(data_id, locations) - except TypeError as type_err: - LOGGER.error(type_err) - - # Return the locations. - return locations diff --git a/app/services/location/jhu.py b/app/services/location/jhu.py index ebed3960..475b8e48 100644 --- a/app/services/location/jhu.py +++ b/app/services/location/jhu.py @@ -15,20 +15,99 @@ from ...utils import countries from ...utils import date as date_util from ...utils import httputils -from . import LocationService +from . import ILocationService, LocationService LOGGER = logging.getLogger("services.location.jhu") PID = os.getpid() -class JhuLocationService(LocationService): +class JhuLocationService(ILocationService): """ Service for retrieving locations from Johns Hopkins CSSE (https://github.com/CSSEGISandData/COVID-19). """ + def __init__(self): + pass + + @cached(cache=TTLCache(maxsize=1, ttl=1800)) + async def get_locations(self): + """ + Retrieves the locations from the categories. The locations are cached for 1 hour. + + :returns: The locations. + :rtype: List[Location] + """ + data_id = "jhu.locations" + LOGGER.info(f"pid:{PID}: {data_id} Requesting data...") + # Get all of the data categories locations. + confirmed = await get_category("confirmed") + deaths = await get_category("deaths") + recovered = await get_category("recovered") + + locations_confirmed = confirmed["locations"] + locations_deaths = deaths["locations"] + locations_recovered = recovered["locations"] + + # Final locations to return. + locations = [] + # *************************************************************************** + # TODO: This iteration approach assumes the indexes remain the same + # and opens us to a CRITICAL ERROR. The removal of a column in the data source + # would break the API or SHIFT all the data confirmed, deaths, recovery producting + # incorrect data to consumers. + # *************************************************************************** + # Go through locations. + for index, location in enumerate(locations_confirmed): + # Get the timelines. + + # TEMP: Fix for merging recovery data. See TODO above for more details. + key = (location["country"], location["province"]) + + timelines = { + "confirmed": location["history"], + "deaths": parse_history(key, locations_deaths, index), + "recovered": parse_history(key, locations_recovered, index), + } + + # Grab coordinates. + coordinates = location["coordinates"] + + # Create location (supporting timelines) and append. + locations.append( + TimelinedLocation( + # General info. + index, + location["country"], + location["province"], + # Coordinates. + Coordinates(latitude=coordinates["lat"], longitude=coordinates["long"]), + # Last update. + datetime.utcnow().isoformat() + "Z", + # Timelines (parse dates as ISO). + { + "confirmed": Timeline( + timeline={ + datetime.strptime(date, "%m/%d/%y").isoformat() + "Z": amount + for date, amount in timelines["confirmed"].items() + } + ), + "deaths": Timeline( + timeline={ + datetime.strptime(date, "%m/%d/%y").isoformat() + "Z": amount + for date, amount in timelines["deaths"].items() + } + ), + "recovered": Timeline( + timeline={ + datetime.strptime(date, "%m/%d/%y").isoformat() + "Z": amount + for date, amount in timelines["recovered"].items() + } + ), + }, + ) + ) + LOGGER.info(f"{data_id} Data normalized") - async def get_all(self): - # Get the locations. - locations = await get_locations() + # Finally, return the locations. return locations async def get(self, loc_id): # pylint: disable=arguments-differ @@ -37,6 +116,90 @@ async def get(self, loc_id): # pylint: disable=arguments-differ return locations[loc_id] + + @cached(cache=TTLCache(maxsize=4, ttl=1800)) + async def get_category(self, category): + print("WORKING HERE --------------------") + """ + Retrieves the data for the provided category. The data is cached for 30 minutes locally, 1 hour via shared Redis. + + :returns: The data for category. + :rtype: dict + """ + # Adhere to category naming standard. + category = category.lower() + data_id = f"jhu.{category}" + + # check shared cache + cache_results = await check_cache(data_id) + if cache_results: + LOGGER.info(f"{data_id} using shared cache results") + results = cache_results + else: + LOGGER.info(f"{data_id} shared cache empty") + # URL to request data from. + url = BASE_URL + "time_series_covid19_%s_global.csv" % category + + # Request the data + LOGGER.info(f"{data_id} Requesting data...") + async with httputils.CLIENT_SESSION.get(url) as response: + text = await response.text() + + LOGGER.debug(f"{data_id} Data received") + + # Parse the CSV. + data = list(csv.DictReader(text.splitlines())) + LOGGER.debug(f"{data_id} CSV parsed") + + # The normalized locations. + locations = [] + + for item in data: + # Filter out all the dates. + dates = dict(filter(lambda element: date_util.is_date(element[0]), item.items())) + + # Make location history from dates. + history = {date: int(float(amount or 0)) for date, amount in dates.items()} + + # Country for this location. + country = item["Country/Region"] + + # Latest data insert value. + latest = list(history.values())[-1] + + # Normalize the item and append to locations. + locations.append( + { + # General info. + "country": country, + "country_code": countries.country_code(country), + "province": item["Province/State"], + # Coordinates. + "coordinates": {"lat": item["Lat"], "long": item["Long"],}, + # History. + "history": history, + # Latest statistic. + "latest": int(latest or 0), + } + ) + LOGGER.debug(f"{data_id} Data normalized") + + # Latest total. + latest = sum(map(lambda location: location["latest"], locations)) + + # Return the final data. + results = { + "locations": locations, + "latest": latest, + "last_updated": datetime.utcnow().isoformat() + "Z", + "source": "https://github.com/ExpDev07/coronavirus-tracker-api", + } + # save the results to distributed cache + await load_cache(data_id, results) + + LOGGER.info(f"{data_id} results:\n{pf(results, depth=1)}") + return results + # --------------------------------------------------------------- @@ -44,8 +207,29 @@ async def get(self, loc_id): # pylint: disable=arguments-differ BASE_URL = "https://raw.githubusercontent.com/CSSEGISandData/2019-nCoV/master/csse_covid_19_data/csse_covid_19_time_series/" + +def parse_history(key: tuple, locations: list, index: int): + """ + Helper for validating and extracting history content from + locations data based on index. Validates with the current country/province + key to make sure no index/column issue. + + TEMP: solution because implement a more efficient and better approach in the refactor. + """ + location_history = {} + try: + if key == (locations[index]["country"], locations[index]["province"]): + location_history = locations[index]["history"] + except (IndexError, KeyError): + LOGGER.debug(f"iteration data merge error: {index} {key}") + + return location_history + + +'''DUPLICATION TO MAKE THIS COMPATIBLE WITH V1.PY AND NOT BREAK FUNCTIONALLITY''' @cached(cache=TTLCache(maxsize=4, ttl=1800)) async def get_category(category): + print("WORKING HERE --------------------") """ Retrieves the data for the provided category. The data is cached for 30 minutes locally, 1 hour via shared Redis. @@ -124,105 +308,4 @@ async def get_category(category): await load_cache(data_id, results) LOGGER.info(f"{data_id} results:\n{pf(results, depth=1)}") - return results - - -@cached(cache=TTLCache(maxsize=1, ttl=1800)) -async def get_locations(): - """ - Retrieves the locations from the categories. The locations are cached for 1 hour. - - :returns: The locations. - :rtype: List[Location] - """ - data_id = "jhu.locations" - LOGGER.info(f"pid:{PID}: {data_id} Requesting data...") - # Get all of the data categories locations. - confirmed = await get_category("confirmed") - deaths = await get_category("deaths") - recovered = await get_category("recovered") - - locations_confirmed = confirmed["locations"] - locations_deaths = deaths["locations"] - locations_recovered = recovered["locations"] - - # Final locations to return. - locations = [] - # *************************************************************************** - # TODO: This iteration approach assumes the indexes remain the same - # and opens us to a CRITICAL ERROR. The removal of a column in the data source - # would break the API or SHIFT all the data confirmed, deaths, recovery producting - # incorrect data to consumers. - # *************************************************************************** - # Go through locations. - for index, location in enumerate(locations_confirmed): - # Get the timelines. - - # TEMP: Fix for merging recovery data. See TODO above for more details. - key = (location["country"], location["province"]) - - timelines = { - "confirmed": location["history"], - "deaths": parse_history(key, locations_deaths, index), - "recovered": parse_history(key, locations_recovered, index), - } - - # Grab coordinates. - coordinates = location["coordinates"] - - # Create location (supporting timelines) and append. - locations.append( - TimelinedLocation( - # General info. - index, - location["country"], - location["province"], - # Coordinates. - Coordinates(latitude=coordinates["lat"], longitude=coordinates["long"]), - # Last update. - datetime.utcnow().isoformat() + "Z", - # Timelines (parse dates as ISO). - { - "confirmed": Timeline( - timeline={ - datetime.strptime(date, "%m/%d/%y").isoformat() + "Z": amount - for date, amount in timelines["confirmed"].items() - } - ), - "deaths": Timeline( - timeline={ - datetime.strptime(date, "%m/%d/%y").isoformat() + "Z": amount - for date, amount in timelines["deaths"].items() - } - ), - "recovered": Timeline( - timeline={ - datetime.strptime(date, "%m/%d/%y").isoformat() + "Z": amount - for date, amount in timelines["recovered"].items() - } - ), - }, - ) - ) - LOGGER.info(f"{data_id} Data normalized") - - # Finally, return the locations. - return locations - - -def parse_history(key: tuple, locations: list, index: int): - """ - Helper for validating and extracting history content from - locations data based on index. Validates with the current country/province - key to make sure no index/column issue. - - TEMP: solution because implement a more efficient and better approach in the refactor. - """ - location_history = {} - try: - if key == (locations[index]["country"], locations[index]["province"]): - location_history = locations[index]["history"] - except (IndexError, KeyError): - LOGGER.debug(f"iteration data merge error: {index} {key}") - - return location_history + return results \ No newline at end of file diff --git a/app/services/location/nyt.py b/app/services/location/nyt.py index 1f25ec34..b3ed869b 100644 --- a/app/services/location/nyt.py +++ b/app/services/location/nyt.py @@ -11,21 +11,94 @@ from ...location.nyt import NYTLocation from ...models import Timeline from ...utils import httputils -from . import LocationService +from . import ILocationService, LocationService LOGGER = logging.getLogger("services.location.nyt") -class NYTLocationService(LocationService): +class NYTLocationService(ILocationService): """ Service for retrieving locations from New York Times (https://github.com/nytimes/covid-19-data). """ - async def get_all(self): - # Get the locations. - locations = await get_locations() + @cached(cache=TTLCache(maxsize=1, ttl=1800)) + async def get_locations(self): + """ + Returns a list containing parsed NYT data by US county. The data is cached for 1 hour. + + :returns: The complete data for US Counties. + :rtype: dict + """ + data_id = "nyt.locations" + # Request the data. + LOGGER.info(f"{data_id} Requesting data...") + # check shared cache + cache_results = await check_cache(data_id) + if cache_results: + LOGGER.info(f"{data_id} using shared cache results") + locations = cache_results + else: + LOGGER.info(f"{data_id} shared cache empty") + async with httputils.CLIENT_SESSION.get(BASE_URL) as response: + text = await response.text() + + LOGGER.debug(f"{data_id} Data received") + + # Parse the CSV. + data = list(csv.DictReader(text.splitlines())) + LOGGER.debug(f"{data_id} CSV parsed") + + # Group together locations (NYT data ordered by dates not location). + grouped_locations = get_grouped_locations_dict(data) + + # The normalized locations. + locations = [] + + for idx, (county_state, histories) in enumerate(grouped_locations.items()): + # Make location history for confirmed and deaths from dates. + # List is tuples of (date, amount) in order of increasing dates. + confirmed_list = histories["confirmed"] + confirmed_history = {date: int(amount or 0) for date, amount in confirmed_list} + + deaths_list = histories["deaths"] + deaths_history = {date: int(amount or 0) for date, amount in deaths_list} + + # Normalize the item and append to locations. + locations.append( + NYTLocation( + id=idx, + state=county_state[1], + county=county_state[0], + coordinates=Coordinates(None, None), # NYT does not provide coordinates + last_updated=datetime.utcnow().isoformat() + "Z", # since last request + timelines={ + "confirmed": Timeline( + timeline={ + datetime.strptime(date, "%Y-%m-%d").isoformat() + "Z": amount + for date, amount in confirmed_history.items() + } + ), + "deaths": Timeline( + timeline={ + datetime.strptime(date, "%Y-%m-%d").isoformat() + "Z": amount + for date, amount in deaths_history.items() + } + ), + "recovered": Timeline(), + }, + ) + ) + LOGGER.info(f"{data_id} Data normalized") + # save the results to distributed cache + # TODO: fix json serialization + try: + await load_cache(data_id, locations) + except TypeError as type_err: + LOGGER.error(type_err) + return locations + async def get(self, loc_id): # pylint: disable=arguments-differ # Get location at the index equal to provided id. locations = await self.get_all() @@ -66,80 +139,3 @@ def get_grouped_locations_dict(data): return grouped_locations - -@cached(cache=TTLCache(maxsize=1, ttl=1800)) -async def get_locations(): - """ - Returns a list containing parsed NYT data by US county. The data is cached for 1 hour. - - :returns: The complete data for US Counties. - :rtype: dict - """ - data_id = "nyt.locations" - # Request the data. - LOGGER.info(f"{data_id} Requesting data...") - # check shared cache - cache_results = await check_cache(data_id) - if cache_results: - LOGGER.info(f"{data_id} using shared cache results") - locations = cache_results - else: - LOGGER.info(f"{data_id} shared cache empty") - async with httputils.CLIENT_SESSION.get(BASE_URL) as response: - text = await response.text() - - LOGGER.debug(f"{data_id} Data received") - - # Parse the CSV. - data = list(csv.DictReader(text.splitlines())) - LOGGER.debug(f"{data_id} CSV parsed") - - # Group together locations (NYT data ordered by dates not location). - grouped_locations = get_grouped_locations_dict(data) - - # The normalized locations. - locations = [] - - for idx, (county_state, histories) in enumerate(grouped_locations.items()): - # Make location history for confirmed and deaths from dates. - # List is tuples of (date, amount) in order of increasing dates. - confirmed_list = histories["confirmed"] - confirmed_history = {date: int(amount or 0) for date, amount in confirmed_list} - - deaths_list = histories["deaths"] - deaths_history = {date: int(amount or 0) for date, amount in deaths_list} - - # Normalize the item and append to locations. - locations.append( - NYTLocation( - id=idx, - state=county_state[1], - county=county_state[0], - coordinates=Coordinates(None, None), # NYT does not provide coordinates - last_updated=datetime.utcnow().isoformat() + "Z", # since last request - timelines={ - "confirmed": Timeline( - timeline={ - datetime.strptime(date, "%Y-%m-%d").isoformat() + "Z": amount - for date, amount in confirmed_history.items() - } - ), - "deaths": Timeline( - timeline={ - datetime.strptime(date, "%Y-%m-%d").isoformat() + "Z": amount - for date, amount in deaths_history.items() - } - ), - "recovered": Timeline(), - }, - ) - ) - LOGGER.info(f"{data_id} Data normalized") - # save the results to distributed cache - # TODO: fix json serialization - try: - await load_cache(data_id, locations) - except TypeError as type_err: - LOGGER.error(type_err) - - return locations