Merge branch 'master' into format

Author: ExpDev07

.all-contributorsrc

@@ -90,7 +90,9 @@
       "avatar_url": "https://avatars0.githubusercontent.com/u/13730460?v=4",
       "profile": "https://github.com/Abdirahiim",
       "contributions": [
-        "doc"
+        "doc",
+        "tool",
+        "platform"
       ]
     },
     {

.gitignore

@@ -63,4 +63,7 @@ coverage.xml
 docs/_build/
 
 # PyBuilder
-target/
+target/
+
+# OSX Stuff
+.DS_Store

README.md

@@ -129,6 +129,7 @@ __Sample response__
     "id": 39,
     "country": "Norway",
     "country_code": "NO",
+    "country_population": 5009150,
     "province": "",
     "county": "",
     "last_updated": "2020-03-21T06:59:11.315422Z",
@@ -174,6 +175,7 @@ __Sample response__
       "id": 0,
       "country": "Thailand",
       "country_code": "TH",
+      "country_population": 67089500,
       "province": "",
       "county": "",
       "last_updated": "2020-03-21T06:59:11.315422Z",
@@ -252,6 +254,7 @@ __Sample Response__
       "id": 16,
       "country": "Italy",
       "country_code": "IT",
+      "country_population": 60340328,
       "province": "",
       "county": "",
       "last_updated": "2020-03-23T13:32:23.913872Z",
@@ -291,6 +294,7 @@ __Sample Response__
       "id": 0,
       "country": "US",
       "country_code": "US",
+      "country_population": 310232863,
       "province": "New York",
       "state": "New York",
       "county": "New York",
@@ -309,6 +313,7 @@ __Sample Response__
       "id": 1,
       "country": "US",
       "country_code": "US",
+      "country_population": 310232863,
       "province": "New York",
       "state": "New York",
       "county": "Westchester",
@@ -432,7 +437,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   </tr>
   <tr>
     <td align="center"><a href="https://github.com/SeanCena"><img src="https://avatars1.githubusercontent.com/u/17202203?v=4" width="100px;" alt=""/><br /><sub><b>SeanCena</b></sub></a><br /><a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=SeanCena" title="Code">💻</a> <a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=SeanCena" title="Documentation">📖</a> <a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=SeanCena" title="Tests">⚠️</a></td>
-    <td align="center"><a href="https://github.com/Abdirahiim"><img src="https://avatars0.githubusercontent.com/u/13730460?v=4" width="100px;" alt=""/><br /><sub><b>Abdirahiim Yassin </b></sub></a><br /><a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=Abdirahiim" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/Abdirahiim"><img src="https://avatars0.githubusercontent.com/u/13730460?v=4" width="100px;" alt=""/><br /><sub><b>Abdirahiim Yassin </b></sub></a><br /><a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=Abdirahiim" title="Documentation">📖</a> <a href="#tool-Abdirahiim" title="Tools">🔧</a> <a href="#platform-Abdirahiim" title="Packaging/porting to new platform">📦</a></td>
     <td align="center"><a href="https://github.com/kant"><img src="https://avatars1.githubusercontent.com/u/32717?v=4" width="100px;" alt=""/><br /><sub><b>Darío Hereñú</b></sub></a><br /><a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=kant" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/o-ba"><img src="https://avatars1.githubusercontent.com/u/8812114?v=4" width="100px;" alt=""/><br /><sub><b>Oliver</b></sub></a><br /><a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=o-ba" title="Documentation">📖</a></td>
     <td align="center"><a href="http://www.carmelagreco.dev"><img src="https://avatars0.githubusercontent.com/u/5394906?v=4" width="100px;" alt=""/><br /><sub><b>carmelag</b></sub></a><br /><a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=carmelag" title="Documentation">📖</a></td>

app/location/__init__.py

@@ -1,5 +1,6 @@
 from ..coordinates import Coordinates
 from ..utils import countrycodes
+from ..utils.populations import country_population
 
 
 class Location:
@@ -26,9 +27,22 @@ def __init__(self, id, country, province, coordinates, last_updated, confirmed,
     def country_code(self):
         """
         Gets the alpha-2 code represention of the country. Returns 'XX' if none is found.
+
+        :returns: The country code.
+        :rtype: str
         """
         return (countrycodes.country_code(self.country) or countrycodes.default_code).upper()
 
+    @property
+    def country_population(self):
+        """
+        Gets the population of this location.
+
+        :returns: The population.
+        :rtype: int
+        """
+        return country_population(self.country_code)
+
     def serialize(self):
         """
         Serializes the location into a dict.
@@ -38,10 +52,11 @@ def serialize(self):
         """
         return {
             # General info.
-            "id": self.id,
-            "country": self.country,
-            "country_code": self.country_code,
-            "province": self.province,
+            'id'                : self.id,
+            'country'           : self.country, 
+            'country_code'      : self.country_code,
+            'country_population': self.country_population,
+            'province'          : self.province,
             # Coordinates.
             "coordinates": self.coordinates.serialize(),
             # Last updated.

app/models/location.py

@@ -14,9 +14,10 @@ class Location(BaseModel):
     id: int
     country: str
     country_code: str
-    county: str = ""
-    province: str = ""
-    last_updated: str  # TODO use datetime.datetime type.
+    country_population: int = None
+    province: str = ''
+    county: str = ''
+    last_updated: str # TODO use datetime.datetime type.
     coordinates: Dict
     latest: Latest
     timelines: Timelines = {}

app/utils/countrycodes.py

@@ -1,3 +1,5 @@
+from itertools import chain
+
 # Default country code.
 default_code = "XX"
 
@@ -366,12 +368,14 @@ def country_code(country):
     Return two letter country code (Alpha-2) according to https://en.wikipedia.org/wiki/ISO_3166-1
     Defaults to "XX".
     """
+    # Look in synonyms if not found.
+    if not country in is_3166_1 and country in synonyms:
+        country = synonyms[country]
+
+    # Return code if country was found.
     if country in is_3166_1:
         return is_3166_1[country]
-    else:
-        if country in synonyms:
-            synonym = synonyms[country]
-            return is_3166_1[synonym]
-        else:
-            print("No country_code found for '" + country + "'. Using '" + default_code + "'")
-            return default_code
+
+    # Default to default_code.
+    print ("No country_code found for '" + country + "'. Using '" + default_code + "'")
+    return default_code

app/utils/populations.py

@@ -0,0 +1,43 @@
+import requests
+from io import StringIO, BytesIO
+from cachetools import cached, TTLCache
+from zipfile import ZipFile, ZipInfo
+from .countrycodes import country_code
+
+# Fetching of the populations.
+def fetch_populations():
+    """
+    Returns a dictionary containing the population of each country fetched from the GeoNames (https://www.geonames.org/).
+    
+    :returns: The mapping of populations.
+    :rtype: dict
+    """
+    print ("Fetching populations...")
+
+    # Mapping of populations
+    mappings = {}
+
+    # Fetch the countries.
+    countries = requests.get("http://api.geonames.org/countryInfoJSON?username=dperic").json()['geonames']
+
+    # Go through all the countries and perform the mapping.
+    for country in countries:
+        mappings.update({ country["countryCode"]: int(country["population"]) or None })
+
+    # Finally, return the mappings.
+    return mappings
+
+# Mapping of alpha-2 codes country codes to population.
+populations = fetch_populations()
+
+# Retrieving.
+def country_population(country_code, default=None):
+    """
+    Fetches the population of the country with the provided country code.
+
+    :returns: The population.
+    :rtype: int
+    """
+    return populations.get(country_code, default)
+
+

tests/test_location.py

@@ -13,7 +13,6 @@ def __init__(self, latest):
 
     return TestTimeline(args[0])
 
-
 @pytest.mark.parametrize(
     "test_id, country, country_code, province, latitude, longitude, confirmed_latest, deaths_latest, recovered_latest",
     [
@@ -35,13 +34,12 @@ def test_location_class(
     deaths_latest,
     recovered_latest,
 ):
-
     # id, country, province, coordinates, confirmed, deaths, recovered
     coords = coordinates.Coordinates(latitude=latitude, longitude=longitude)
 
     # Timelines
     confirmed = timeline.Timeline(confirmed_latest)
-    deaths = timeline.Timeline(deaths_latest)
+    deaths    = timeline.Timeline(deaths_latest)
     recovered = timeline.Timeline(recovered_latest)
 
     # Date now.
@@ -53,16 +51,4 @@ def test_location_class(
     )
 
     assert location_obj.country_code == country_code
-
-    # validate serialize
-    check_dict = {
-        "id": test_id,
-        "country": country,
-        "country_code": country_code,
-        "province": province,
-        "last_updated": now,
-        "coordinates": {"latitude": latitude, "longitude": longitude},
-        "latest": {"confirmed": confirmed_latest, "deaths": deaths_latest, "recovered": recovered_latest},
-    }
-
-    assert location_obj.serialize() == check_dict
+    assert not location_obj.serialize() == None