Merge pull request #76 from ExpDev07/timelines-option

Timelines option

Author: ExpDev07

README.md

@@ -74,7 +74,12 @@ Additionally, you can also filter by country ([alpha-2 country_code](https://en.
 GET /v2/locations?country_code=US
 ```
 
-### Getting a specific location (includes timeline).
+Include timelines.
+```http
+GET /v2/locations?country_code=US&timelines=true
+```
+
+### Getting a specific location (includes timeline by default).
 ```http
 GET /v2/locations/:id
 ```

app/coordinates.py

@@ -10,6 +10,9 @@ def __init__(self, latitude, longitude):
     def serialize(self):
         """
         Serializes the coordinates into a dict.
+
+        :returns: The serialized coordinates.
+        :rtype: dict
         """
         return {
             'latitude' : self.latitude,

app/location.py

@@ -26,11 +26,15 @@ def country_code(self):
         """
         return (countrycodes.country_code(self.country) or countrycodes.default_code).upper()
 
-    def serialize(self):
+    def serialize(self, timelines = False):
         """
         Serializes the location into a dict.
+
+        :param timelines: Whether to include the timelines.
+        :returns: The serialized location.
+        :rtype: dict
         """
-        return {
+        serialized = {
             # General info.
             'id'          : self.id,
             'country'     : self.country, 
@@ -45,5 +49,16 @@ def serialize(self):
                 'confirmed': self.confirmed.latest,
                 'deaths'   : self.deaths.latest,
                 'recovered': self.recovered.latest
-            }
-        }
+            },
+        }
+
+        # Whether to include the timelines or not.
+        if timelines:
+            serialized.update({ 'timelines': {
+                'confirmed': self.confirmed.serialize(),
+                'deaths'   : self.deaths.serialize(),
+                'recovered': self.recovered.serialize(),
+            }})
+
+        # Return the serialized location.
+        return serialized

app/routes/v2/locations.py

@@ -4,6 +4,7 @@
 @app.route('/v2/locations')
 def locations():
     # Query parameters.
+    timelines    = request.args.get('timelines', type=bool, default=False)
     country_code = request.args.get('country_code', type=str)
 
     # Retrieve all the locations.
@@ -16,25 +17,13 @@ def locations():
     # Serialize each location and return.
     return jsonify({
         'locations': [
-            location.serialize() for location in locations
+            location.serialize(timelines) for location in locations
         ]
     })
 
 @app.route('/v2/locations/<int:id>')
 def location(id):
-    # Retrieve location with the provided id.
-    location = jhu.get(id)
-
-    # Get all the timelines.
-    timelines = {
-        'confirmed': location.confirmed.serialize(),
-        'deaths'   : location.deaths.serialize(),
-        'recovered': location.recovered.serialize(),
-    }
-
-    # Serialize the location, add timelines, and then return.
+    # Serialize the location with timelines.
     return jsonify({
-        'location': {
-            **jhu.get(id).serialize(), **{ 'timelines': timelines }
-        }
+        'location': jhu.get(id).serialize(True)
     })

app/timeline.py

@@ -25,7 +25,10 @@ def latest(self):
 
     def serialize(self):
         """
-        Serializes the data into a dict.
+        Serializes the timeline into a dict.
+
+        :returns: The serialized timeline.
+        :rtype: dict
         """
         return {
             'latest'  : self.latest,