Added ability to use filters for aggregate data

Author: SeanCena

README.md

@@ -15,6 +15,16 @@
 
 All requests must be made to the base url: ``https://coronavirus-tracker-api.herokuapp.com/v2/`` (e.g: https://coronavirus-tracker-api.herokuapp.com/v2/locations). You can try them out in your browser to further inspect responses.
 
+### Picking data source
+
+We provide multiple data-sources you can pick from, simply add the query paramater ``?source=your_source_of_choice`` to your requests. JHU will be used as a default if you don't provide one.
+
+#### Available sources:
+
+* **jhu** - https://github.com/CSSEGISandData/COVID-19 - Data repository operated by the Johns Hopkins University Center for Systems Science and Engineering (JHU CSSE).
+
+* **... more to come later**.
+
 ### Getting latest amount of total confirmed cases, deaths, and recoveries.
 ```http
 GET /v2/latest
@@ -41,6 +51,7 @@ GET /v2/locations
       "country": "Thailand",
       "country_code": "TH",
       "province": "",
+      "last_updated": "2020-03-21T06:59:11.315422Z",
       "coordinates": {
         "latitude": "15",
         "longitude": "101"
@@ -56,6 +67,7 @@ GET /v2/locations
       "country": "Norway",
       "country_code": "NO",
       "province": "",
+      "last_updated": "2020-03-21T06:59:11.315422Z",
       "coordinates": {
         "latitude": "60.472",
         "longitude": "8.4689"
@@ -91,6 +103,7 @@ GET /v2/locations/:id
     "country": "Norway",
     "country_code": "NO",
     "province": "",
+    "last_updated": "2020-03-21T06:59:11.315422Z",
     "coordinates": { },
     "latest": { },
     "timelines": {
@@ -121,7 +134,7 @@ programmatically retrieved, re-formatted and stored in the cache for one hour.
 
 ## Wrappers
 
-These are the available API wrappers created by the community. They are not neccecarily maintained by any of this project's authors or contributors.
+These are the available API wrappers created by the community. They are not necessarily maintained by any of this project's authors or contributors.
 
 ### C#
 

app/__init__.py

@@ -8,7 +8,6 @@ def create_app():
     """
     Construct the core application.
     """
-
     # Create flask app with CORS enabled.
     app = Flask(__name__)
     CORS(app)

app/data/__init__.py

@@ -0,0 +1,15 @@
+from ..services.location.jhu import JhuLocationService
+
+# Mapping of services to data-sources.
+data_sources = {
+    'jhu': JhuLocationService(),
+}
+
+def data_source(source):
+    """
+    Retrieves the provided data-source service.
+
+    :returns: The service.
+    :rtype: LocationService
+    """
+    return data_sources.get(source.lower())

app/location.py

@@ -0,0 +1,96 @@
+from ..coordinates import Coordinates
+from ..utils import countrycodes
+
+class Location:
+    """
+    A location in the world affected by the coronavirus.
+    """
+
+    def __init__(self, id, country, province, coordinates, last_updated, confirmed, deaths, recovered):
+        # General info.
+        self.id = id
+        self.country = country.strip()
+        self.province = province.strip()
+        self.coordinates = coordinates
+
+        # Last update.
+        self.last_updated = last_updated
+
+        # Statistics.
+        self.confirmed = confirmed
+        self.deaths = deaths
+        self.recovered = recovered
+        
+    @property
+    def country_code(self):
+        """
+        Gets the alpha-2 code represention of the country. Returns 'XX' if none is found.
+        """
+        return (countrycodes.country_code(self.country) or countrycodes.default_code).upper()
+
+    def serialize(self):
+        """
+        Serializes the location into a dict.
+
+        :returns: The serialized location.
+        :rtype: dict
+        """
+        return {
+            # General info.
+            'id'          : self.id,
+            'country'     : self.country, 
+            'country_code': self.country_code,
+            'province'    : self.province,
+
+            # Coordinates.
+            'coordinates': self.coordinates.serialize(),
+
+            # Last updated.
+            'last_updated': self.last_updated,
+
+            # Latest data (statistics).
+            'latest': {
+                'confirmed': self.confirmed,
+                'deaths'   : self.deaths,
+                'recovered': self.recovered
+            },
+        }
+
+class TimelinedLocation(Location):
+    """
+    A location with timelines.
+    """
+
+    def __init__(self, id, country, province, coordinates, last_updated, timelines):
+        super().__init__(
+            # General info.
+            id, country, province, coordinates, last_updated,
+
+            # Statistics (retrieve latest from timelines).
+            confirmed=timelines.get('confirmed').latest or 0,
+            deaths=timelines.get('deaths').latest or 0,
+            recovered=timelines.get('recovered').latest or 0,
+        )
+
+        # Set timelines.
+        self.timelines = timelines
+
+    def serialize(self, timelines = False):
+        """
+        Serializes the location into a dict.
+
+        :param timelines: Whether to include the timelines.
+        :returns: The serialized location.
+        :rtype: dict
+        """
+        serialized = super().serialize()
+
+        # Whether to include the timelines or not.
+        if timelines:
+            serialized.update({ 'timelines': {
+                # Serialize all the timelines.
+                key: value.serialize() for (key, value) in self.timelines.items()
+            }})
+
+        # Return the serialized location.
+        return serialized

app/location/__init__.py

@@ -1,4 +1,5 @@
-from flask import Blueprint, redirect, current_app as app
+from flask import Blueprint, redirect, request, current_app as app
+from ..data import data_source
 
 # Follow the import order to avoid circular dependency
 api_v1 = Blueprint('api_v1', __name__, url_prefix='')
@@ -14,3 +15,16 @@
 @app.route('/')
 def index():
     return redirect('https://github.com/ExpDev07/coronavirus-tracker-api', 302)
+
+# Middleware for picking data source.
+@api_v2.before_request
+def datasource():
+    """
+    Attaches the datasource to the request.
+    """
+    # Retrieve the datas ource from query param.
+    source = request.args.get('source', type=str, default='jhu')
+
+    # Attach source to request and return it.
+    request.source = data_source(source)
+    pass

app/routes/__init__.py

@@ -1 +0,0 @@
-

app/routes/v2/__init__.py

@@ -1,26 +1,26 @@
-from flask import jsonify, request
+from flask import request, jsonify
 from ...routes import api_v2 as api
-from ...services import jhu
 
 @api.route('/latest')
 def latest():
-    #Query parameters.
-    country_code = request.args.get('country_code', type=str)
+    # Query parameters.
+    args = request.args
 
     # Get the serialized version of all the locations.
-    locations = [ location.serialize() for location in jhu.get_all() ]
+    locations = request.source.get_all()
+    #print([i.country_code for i in locations])
 
-    # Return aggregate data for country if provided.
-    if not country_code is None:
-        locations = list(filter(lambda location: location['country_code'] == country_code.upper(), locations))
+    # Filter based on args.
+    if len(args) > 0:
+        locations = [i for i in locations for j in args if hasattr(i, j) and getattr(i, j) == args[j]]
 
     # All the latest information.
-    latest = list(map(lambda location: location['latest'], locations))
+    # latest = list(map(lambda location: location['latest'], locations))
 
     return jsonify({
         'latest': {
-            'confirmed': sum(map(lambda latest: latest['confirmed'], latest)),
-            'deaths'   : sum(map(lambda latest: latest['deaths'], latest)),
-            'recovered': sum(map(lambda latest: latest['recovered'], latest)),
+            'confirmed': sum(map(lambda location: location.confirmed, locations)),
+            'deaths'   : sum(map(lambda location: location.deaths, locations)),
+            'recovered': sum(map(lambda location: location.recovered, locations)),
         }
     })

app/routes/v2/latest.py

@@ -1,7 +1,6 @@
 from flask import jsonify, request
 from distutils.util import strtobool
 from ...routes import api_v2 as api
-from ...services import jhu
 
 @api.route('/locations')
 def locations():
@@ -10,7 +9,7 @@ def locations():
     country_code = request.args.get('country_code', type=str)
 
     # Retrieve all the locations.
-    locations = jhu.get_all()
+    locations = request.source.get_all()
 
     # Filtering my country code if provided.
     if not country_code is None:
@@ -30,5 +29,5 @@ def location(id):
 
     # Return serialized location.
     return jsonify({
-        'location': jhu.get(id).serialize(timelines)
+        'location': request.source.get(id).serialize(timelines)
     })

app/routes/v2/locations.py

@@ -1,5 +1,5 @@
 from . import LocationService
-from ...location import Location
+from ...location import TimelinedLocation
 from ...coordinates import Coordinates
 from ...timeline import Timeline
 
@@ -16,6 +16,8 @@ def get(self, id):
         # Get location at the index equal to provided id.
         return self.get_all()[id]
 
+# ---------------------------------------------------------------
+
 import requests
 import csv
 from datetime import datetime
@@ -121,15 +123,26 @@ def get_locations():
         # Grab coordinates.
         coordinates = location['coordinates']
 
-        # Create location and append.
-        locations.append(Location(
+        # Create location (supporting timelines) and append.
+        locations.append(TimelinedLocation(
             # General info.
-            index, location['country'], location['province'], Coordinates(coordinates['lat'], coordinates['long']),
+            index, location['country'], location['province'], 
+            
+            # Coordinates.
+            Coordinates(
+                coordinates['lat'], 
+                coordinates['long']
+            ),
+
+            # Last update.
+            datetime.utcnow().isoformat() + 'Z',
 
             # Timelines (parse dates as ISO).
-            Timeline({ datetime.strptime(date, '%m/%d/%y').isoformat() + 'Z': amount for date, amount in timelines['confirmed'].items() }),
-            Timeline({ datetime.strptime(date, '%m/%d/%y').isoformat() + 'Z': amount for date, amount in timelines['deaths'].items() }),
-            Timeline({ datetime.strptime(date, '%m/%d/%y').isoformat() + 'Z': amount for date, amount in timelines['recovered'].items() })
+            {
+                'confirmed': Timeline({ datetime.strptime(date, '%m/%d/%y').isoformat() + 'Z': amount for date, amount in timelines['confirmed'].items() }),
+                'deaths'   : Timeline({ datetime.strptime(date, '%m/%d/%y').isoformat() + 'Z': amount for date, amount in timelines['deaths'].items() }),
+                'recovered': Timeline({ datetime.strptime(date, '%m/%d/%y').isoformat() + 'Z': amount for date, amount in timelines['recovered'].items() })
+            }
         ))
 
     # Finally, return the locations.