Apply Bridge pattern

app/data/__init__.py

@@ -1,21 +1,21 @@
 """app.data"""
-from ..services.location.csbs import CSBSLocationService
-from ..services.location.jhu import JhuLocationService
-from ..services.location.nyt import NYTLocationService
+from ..services.location.basiclocationservice import BasicLocationService
+from ..services.location.csbs import CSBSLocations
+from ..services.location.jhu import JHULocations
+from ..services.location.nyt import NYTLocations
 
 # Mapping of services to data-sources.
 DATA_SOURCES = {
-    "jhu": JhuLocationService(),
-    "csbs": CSBSLocationService(),
-    "nyt": NYTLocationService(),
+    "jhu": BasicLocationService(JHULocations()),
+    "csbs": BasicLocationService(CSBSLocations()),
+    "nyt": BasicLocationService(NYTLocations()),
 }
 
 
 def data_source(source):
     """
     Retrieves the provided data-source service.
-
     :returns: The service.
     :rtype: LocationService
     """
-    return DATA_SOURCES.get(source.lower())
+    return DATA_SOURCES.get(source.lower())

app/services/location/__init__.py

@@ -1,11 +1,13 @@
 """app.services.location"""
 from abc import ABC, abstractmethod
-
+from . import DataSourcesInterface
 
 class LocationService(ABC):
     """
     Service for retrieving locations.
     """
+    def __init__(self, dataSource: DataSourcesInterface):
+        self.dataSource = dataSource
 
     @abstractmethod
     async def get_all(self):

app/services/location/basiclocationservice.py

@@ -0,0 +1,19 @@
+"""app.services.location.basiclocationservice.py"""
+
+from . import LocationService
+
+class BasicLocationService(LocationService):
+    """
+    Service for retrieving locations from csbs
+    """
+    async def get_all(self):
+        # Get the locations.
+        locations = await self.dataSource.get_locations()
+        return locations
+
+    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]
+
+

app/services/location/csbs.py

@@ -1,4 +1,3 @@
-"""app.services.location.csbs.py"""
 import csv
 import logging
 from datetime import datetime
@@ -10,93 +9,75 @@
 from ...coordinates import Coordinates
 from ...location.csbs import CSBSLocation
 from ...utils import httputils
-from . import LocationService
+from . import DataSourcesInterface
 
 LOGGER = logging.getLogger("services.location.csbs")
-
-
-class CSBSLocationService(LocationService):
-    """
-    Service for retrieving locations from csbs
-    """
-
-    async def get_all(self):
-        # Get the locations.
-        locations = await get_locations()
-        return locations
-
-    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 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),
+class CSBSLocations(DataSourcesInterface):
+
+    @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
+            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