add sources endpoint and improve datasource middleware

README.md

@@ -26,7 +26,7 @@ All requests must be made to the base url: ``https://coronavirus-tracker-api.her
 
 ### Picking data source
 
-We provide multiple data-sources you can pick from, simply add the query parameter ``?source=your_source_of_choice`` to your requests. JHU will be used as a default if you don't provide one.
+We provide multiple data-sources you can pick from, simply add the query parameter ``?source=your_source_of_choice`` to your requests. JHU will be used as a default if you don't provide one. Dynamically retrieve available sources at ``/v2/sources``.
 
 #### Available sources:
 
@@ -142,58 +142,6 @@ Exclude timelines.
 GET /v2/locations?timelines=0
 ```
 
-### Getting US per county information.
-```http
-GET /v2/locations?source=csbs
-```
-```json
-{
-  "latest": {
-    "confirmed": 7596,
-    "deaths": 43,
-    "recovered": 0
-  },
-  "locations": [
-    {
-      "id": 0,
-      "country": "US",
-      "country_code": "US",
-      "province": "New York",
-      "state": "New York",
-      "county": "New York",
-      "last_updated": "2020-03-21T14:00:00Z",
-      "coordinates": {
-        "latitude": 40.71455,
-        "longitude": -74.00714
-      },
-      "latest": {
-        "confirmed": 6211,
-        "deaths": 43,
-        "recovered": 0
-      }
-    },
-    {
-      "id": 1,
-      "country": "US",
-      "country_code": "US",
-      "province": "New York",
-      "state": "New York",
-      "county": "Westchester",
-      "last_updated": "2020-03-21T14:00:00Z",
-      "coordinates": {
-        "latitude": 41.16319759,
-        "longitude": -73.7560629
-      },
-      "latest": {
-        "confirmed": 1385,
-        "deaths": 0,
-        "recovered": 0
-      },
-    }
-  ]
-}
-```
-
 ## Wrappers
 
 These are the available API wrappers created by the community. They are not necessarily maintained by any of this project's authors or contributors.

app/routes/__init__.py

@@ -1,12 +1,12 @@
-from flask import Blueprint, redirect, request, current_app as app
+from flask import Blueprint, redirect, request, abort, 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='')
 api_v2 = Blueprint('api_v2', __name__, url_prefix='/v2')
 
 # API version 2.
-from .v2 import locations, latest
+from .v2 import locations, latest, sources
 
 # API version 1.
 from .v1 import confirmed, deaths, recovered, all
@@ -23,8 +23,12 @@ def datasource():
     Attaches the datasource to the request.
     """
     # Retrieve the datas ource from query param.
-    source = request.args.get('source', type=str, default='jhu')
+    source = data_source(request.args.get('source', type=str, default='jhu'))
+
+    # Abort with 404 if source cannot be found.
+    if not source:
+        return abort(404, description='The provided data-source was not found.')
 
     # Attach source to request and return it.
-    request.source = data_source(source)
+    request.source = source
     pass

app/routes/v2/locations.py

@@ -17,7 +17,7 @@ def locations():
             try:
                 locations = [j for j in locations if getattr(j, i) == args.get(i, type=str)]
             except AttributeError:
-                print('TimelinedLocation object does not have attribute {}.'.format(i))
+                print('Location does not have attribute {}.'.format(i))
 
     # Serialize each location and return.
     return jsonify({

app/routes/v2/sources.py

@@ -0,0 +1,12 @@
+from flask import jsonify
+from ...data import data_sources
+from ...routes import api_v2 as api
+
+@api.route('/sources')
+def sources():
+    """
+    Retrieves a list of data-sources that are availble to use.
+    """
+    return jsonify({
+        'sources': list(data_sources.keys())
+    })

app/services/location/csbs.py

@@ -38,28 +38,41 @@ def get_locations():
     locations = []
 
     for i, item in enumerate(data):
+        # General info.
         state = item['State Name']
         county = item['County Name']
+
+        # Ensure country is specified.
         if county == "Unassigned" or county == "Unknown":
             continue
 
-        confirmed = int(item['Confirmed'] or 0)
-        death = int(item['Death'] or 0)
-        coordinates = Coordinates(float(item['Latitude']), float(item['Longitude']))
+        # Coordinates.
+        coordinates = Coordinates(
+            item['Latitude'], 
+            item['Longitude']
+        )
+
+        # Date string without "EDT" at end.
+        last_update = ' '.join(item['Last Update'].split(' ')[0:2])
 
-        # Parse time to ISO format
-        last_update = item['Last Update']
-        date = last_update.split("-")
-        year = int(date[0])
-        month = int(date[1])
-        date = date[2].split(" ")
-        day = int(date[0])
-        time = date[1].split(":")
-        hour = int(time[0])
-        minute = int(time[1])
-        d = datetime(year=year, month=month, day=day, hour=hour, minute=minute)
-        last_update = d.isoformat() + 'Z'
+        # Append to locations.
+        locations.append(CSBSLocation(
+            # General info.
+            i, state, county,
+
+            # Coordinates.
+            Coordinates(
+                item['Latitude'], 
+                item['Longitude']
+            ),
 
-        locations.append(CSBSLocation(i, state, county, coordinates, last_update, confirmed, death))
+            # 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)
+        ))
 
+    # Return the locations.
     return locations

tests/example_data/sample_covid19_county.csv

@@ -1,33 +1,33 @@
 County Name,State Name,Confirmed,New,Death,Fatality Rate,Latitude,Longitude,Last Update
-New York,New York,4408,454,26,0.6%,40.71455,-74.00714,2020-03-20 13:58 EDT
-Westchester,New York,1091,293,0,0%,41.16319759,-73.7560629,2020-03-20 13:58 EDT
-Nassau,New York,754,382,4,0.5%,40.74165225,-73.58899619,2020-03-20 13:58 EDT
-Yakima,Washington,7,0,0,0%,46.60448,-120.50721,2020-03-20 13:58 EDT
-Thurston,Washington,6,0,0,0%,46.91980578,-122.8298691,2020-03-20 13:58 EDT
-Jefferson,Washington,4,0,0,0%,47.74810608,-123.6000095,2020-03-20 13:58 EDT
-Douglas,Kansas,1,0,0,0%,38.88462907,-95.29255463,2020-03-20 13:58 EDT
-Cherokee,Kansas,1,0,0,0%,37.16926692,-94.8462675759999,2020-03-20 13:58 EDT
-Jackson,Kansas,1,0,0,0%,39.4168027220001,-95.793674403,2020-03-20 13:58 EDT
-Twin Falls,Idaho,1,0,0,0%,42.55619,-114.4696,2020-03-20 13:58 EDT
-Kootenai,Idaho,1,0,0,0%,47.6775872760001,-116.697131928,2020-03-20 13:58 EDT
-Chittenden,Vermont,4,0,1,25%,44.45799511,-73.05404973,2020-03-20 13:58 EDT
-Bennington,Vermont,3,0,0,0%,42.87672,-73.19818,2020-03-20 13:58 EDT
-Windsor,Vermont,3,0,1,33.3%,43.48115,-72.38581,2020-03-20 13:58 EDT
-Washington,Vermont,1,0,0,0%,44.27344561,-72.61485925,2020-03-20 13:58 EDT
-Orange,Vermont,1,0,0,0%,44.14854,-72.40233,2020-03-20 13:58 EDT
-Addison,Vermont,1,0,0,0%,44.0280736,-73.13152876,2020-03-20 13:58 EDT
-Burleigh,North Dakota,11,0,0,0%,46.97801044,-100.4669442,2020-03-20 13:58 EDT
-Tucker,West Virginia,2,0,0,0%,39.1135508250001,-79.56492129,2020-03-20 13:58 EDT
-Mercer,West Virginia,1,0,0,0%,37.40556515,-81.11143231,2020-03-20 13:58 EDT
-Monongalia,West Virginia,1,0,0,0%,39.630233859,-80.0465546289999,2020-03-20 13:58 EDT
-Unassigned,New York,166,149,4,2.4%,42.165726,-74.948051,2020-03-20 13:58 EDT
-Unassigned,Washington,151,0,0,0%,47.400902,-121.490494,2020-03-20 13:58 EDT
-Unassigned,Colorado,57,0,0,0%,39.059811,-105.311104,2020-03-20 13:58 EDT
-Unknown,Pennsylvania,55,55,0,0%,40.590752,-77.209755,2020-03-20 13:58 EDT
-Unassigned,Pennsylvania,0,0,0,NaN%,40.590752,-77.209755,2020-03-20 13:58 EDT
-Franklin,Pennsylvania,1,1,0,0%,39.927495836,-77.721161869,2020-03-20 13:58 EDT
-Franklin,North Carolina,4,4,0,0%,36.0827448150001,-78.285600305,2020-03-20 13:58 EDT
-Lee,North Carolina,1,1,0,0%,35.475059921,-79.17154054,2020-03-20 13:58 EDT
-Clay,Minnesota,1,1,0,0%,46.892347886,-96.490737839,2020-03-20 13:58 EDT
-Yuma,Arizona,1,1,0,0%,32.768956524,-113.905830295,2020-03-20 13:58 EDT
-Dunklin,Missouri,1,1,0,0%,36.105848973,-90.16563,2020-03-20 13:58 EDT
+New York,New York,4408,454,26,0.6%,40.71455,-74.00714,2020/03/20 13:58 EDT
+Westchester,New York,1091,293,0,0%,41.16319759,-73.7560629,2020/03/20 13:58 EDT
+Nassau,New York,754,382,4,0.5%,40.74165225,-73.58899619,2020/03/20 13:58 EDT
+Yakima,Washington,7,0,0,0%,46.60448,-120.50721,2020/03/20 13:58 EDT
+Thurston,Washington,6,0,0,0%,46.91980578,-122.8298691,2020/03/20 13:58 EDT
+Jefferson,Washington,4,0,0,0%,47.74810608,-123.6000095,2020/03/20 13:58 EDT
+Douglas,Kansas,1,0,0,0%,38.88462907,-95.29255463,2020/03/20 13:58 EDT
+Cherokee,Kansas,1,0,0,0%,37.16926692,-94.8462675759999,2020/03/20 13:58 EDT
+Jackson,Kansas,1,0,0,0%,39.4168027220001,-95.793674403,2020/03/20 13:58 EDT
+Twin Falls,Idaho,1,0,0,0%,42.55619,-114.4696,2020/03/20 13:58 EDT
+Kootenai,Idaho,1,0,0,0%,47.6775872760001,-116.697131928,2020/03/20 13:58 EDT
+Chittenden,Vermont,4,0,1,25%,44.45799511,-73.05404973,2020/03/20 13:58 EDT
+Bennington,Vermont,3,0,0,0%,42.87672,-73.19818,2020/03/20 13:58 EDT
+Windsor,Vermont,3,0,1,33.3%,43.48115,-72.38581,2020/03/20 13:58 EDT
+Washington,Vermont,1,0,0,0%,44.27344561,-72.61485925,2020/03/20 13:58 EDT
+Orange,Vermont,1,0,0,0%,44.14854,-72.40233,2020/03/20 13:58 EDT
+Addison,Vermont,1,0,0,0%,44.0280736,-73.13152876,2020/03/20 13:58 EDT
+Burleigh,North Dakota,11,0,0,0%,46.97801044,-100.4669442,2020/03/20 13:58 EDT
+Tucker,West Virginia,2,0,0,0%,39.1135508250001,-79.56492129,2020/03/20 13:58 EDT
+Mercer,West Virginia,1,0,0,0%,37.40556515,-81.11143231,2020/03/20 13:58 EDT
+Monongalia,West Virginia,1,0,0,0%,39.630233859,-80.0465546289999,2020/03/20 13:58 EDT
+Unassigned,New York,166,149,4,2.4%,42.165726,-74.948051,2020/03/20 13:58 EDT
+Unassigned,Washington,151,0,0,0%,47.400902,-121.490494,2020/03/20 13:58 EDT
+Unassigned,Colorado,57,0,0,0%,39.059811,-105.311104,2020/03/20 13:58 EDT
+Unknown,Pennsylvania,55,55,0,0%,40.590752,-77.209755,2020/03/20 13:58 EDT
+Unassigned,Pennsylvania,0,0,0,NaN%,40.590752,-77.209755,2020/03/20 13:58 EDT
+Franklin,Pennsylvania,1,1,0,0%,39.927495836,-77.721161869,2020/03/20 13:58 EDT
+Franklin,North Carolina,4,4,0,0%,36.0827448150001,-78.285600305,2020/03/20 13:58 EDT
+Lee,North Carolina,1,1,0,0%,35.475059921,-79.17154054,2020/03/20 13:58 EDT
+Clay,Minnesota,1,1,0,0%,46.892347886,-96.490737839,2020/03/20 13:58 EDT
+Yuma,Arizona,1,1,0,0%,32.768956524,-113.905830295,2020/03/20 13:58 EDT
+Dunklin,Missouri,1,1,0,0%,36.105848973,-90.16563,2020/03/20 13:58 EDT