temporary mappings

Author: Kevin Le

README.md

@@ -1,6 +1,6 @@
 # Smartraveller API
 
-A simple API for travel advisories published by the Australian Government on [Smartraveller](https://www.smartraveller.gov.au/).
+A simple API for travel advisories published by the Australian Government DFAT on [Smartraveller](https://www.smartraveller.gov.au/).
 
 **This is not an official API. Visit the Smartraveller website for the latest information.**
 
@@ -22,7 +22,7 @@ Note: Set Vercel function region to `Sydney, Australia (Southeast) - syd1` as re
 
 ## Endpoint(s)
 
-### [GET /advisory](https://smartraveller.api.kevle.xyz/advisory?country=es)
+### [GET /advisory](https://smartraveller.api.kevle.xyz/advisory)
 
 Fetches an advice summary for a country. 
 
@@ -31,10 +31,12 @@ Responses may be cached for up to 1 hour.
 #### Query Parameters 
 
 - country (required)
-  - Note: Fuzzy matches for country - E.g. "Spain" or "ES" is accepted. However it is recommend to use Alpha 3 country codes. 
+  - Note: Fuzzy matches for country - E.g. "Spain" or "ES" is accepted. However it is recommend to use [ISO 3166-1 alpha-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). 
 
 #### Example Response 
 
+https://smartraveller.api.kevle.xyz/advisory?country=es
+
 ```
 {
   "advisory": "Exercise normal safety precautions",
@@ -45,6 +47,14 @@ Responses may be cached for up to 1 hour.
 }
 ```
 
+## Known Problems
+
+Smartraveller uses non-standardised and inconsistent names for countries and does not utilise any standard country codes such as the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) standard. 
+
+Mappings for certain countries have been temporarily added, but may be inconsistent. 
+
+Need to explore if it is possible to build a mapping programatically using the available ["PublishedPages" API](https://www.smartraveller.gov.au/api/publishedpages). 
+
 ## Copyright
 
 Smartraveller material accessed is provided under the latest [Creative Commons Attribution licence](https://creativecommons.org/licenses/by/4.0/). 

api/api.py

@@ -27,9 +27,14 @@ def advisory():
 
             advisory = get_overall_advisory(country_query)
 
+            if advisory is None:
+                return "Smartraveller does not have published advisory for selected country", 404
+            
             advisory["country"] = country.name
             advisory["alpha_2"] = country.alpha_2
-            advisory["official_name"] = country.official_name
+            
+            if hasattr(country, 'official_name'):
+                advisory["official_name"] = country.official_name
 
             response = Response(json.dumps(advisory))
             response.headers['Cache-Control'] = 's-maxage=3600' # Vercel cache for 1 hour

api/smartraveller/advisory.py

@@ -9,13 +9,41 @@
     "Do not travel": 4
 }
 
+# Smartraveller uses non-standardised names for countries - see README.md
+# Temporary permanent solution... 
+special_mappings = {
+    "congo": "democratic-republic-congo",
+    "iran,-islamic-republic-of": "iran",
+    "israel": "middle-east/israel-and-palestinian-territories",
+    "kyrgyzstan": "kyrgyz-republic",
+    "korea,-democratic-people's-republic-of": "north-korea-democratic-peoples-republic-korea",
+    "taiwan,-province-of-china": "taiwan",
+    "united-states": "americas/united-states-america",
+    "viet-nam": "vietnam",
+    "russian-federation": "russia",
+    "greenland": "denmark",
+    "lao-people's-democratic-republic": "laos",
+    "kyrgyzstan": "kyrgyz-republic"
+}
+
 def get_overall_advisory(country: str) -> dict:
-    response = requests.get(f'https://www.smartraveller.gov.au/destinations/{country}', timeout=2)
+    if country in special_mappings:
+        country_query = special_mappings[country]
+    else:
+        country_query = country
+    print(country_query)
+    
+    response = requests.get(f'https://www.smartraveller.gov.au/destinations/{country_query}', timeout=2)
     html = response.content
 
     site = BeautifulSoup(html, 'html.parser')
 
     advisory_block = site.findAll('div', { 'class': 'views-field views-field-field-overall-advice-level'})
+    print(advisory_block)
+    
+    if not advisory_block: 
+        return None
+    
     advisory = advisory_block[0].find('strong').getText()
 
     return {

missing.txt

@@ -0,0 +1,88 @@
+Aruba 
+Anguilla 
+�land Islands 
+Andorra 
+American Samoa 
+Antarctica 
+French Southern Territories 
+Antigua and Barbuda 
+Australia 
+Bonaire, Sint Eustatius and Saba 
+Saint Barth�lemy 
+Bermuda 
+Bolivia, Plurinational State of 
+Barbados 
+Bouvet Island 
+Cocos (Keeling) Islands 
+C�te d'Ivoire 
+Congo, The Democratic Republic of the 
+Comoros 
+Cabo Verde 
+Cura�ao 
+Christmas Island 
+Cayman Islands 
+Czechia 
+Dominica 
+Western Sahara 
+Fiji 
+Falkland Islands (Malvinas) 
+Faroe Islands 
+Micronesia, Federated States of 
+Guernsey 
+Gibraltar 
+Guadeloupe 
+Guinea-Bissau 
+Equatorial Guinea 
+Grenada 
+French Guiana 
+Heard Island and McDonald Islands 
+Isle of Man 
+British Indian Ocean Territory 
+Jersey 
+Kyrgyzstan 
+Kiribati 
+Saint Kitts and Nevis 
+Korea, Republic of 
+Lao People's Democratic Republic 
+Saint Lucia 
+Liechtenstein 
+Luxembourg 
+Macao 
+Saint Martin (French part) 
+Monaco 
+Moldova, Republic of 
+Northern Mariana Islands 
+Montserrat 
+Martinique 
+Mayotte 
+Norfolk Island 
+Niue 
+Nauru 
+Pitcairn 
+Puerto Rico 
+Palestine, State of 
+R�union 
+South Georgia and the South Sandwich Islands 
+Saint Helena, Ascension and Tristan da Cunha 
+Svalbard and Jan Mayen 
+San Marino 
+Saint Pierre and Miquelon 
+Sao Tome and Principe 
+Suriname 
+Slovakia 
+Slovenia 
+Sint Maarten (Dutch part) 
+Syrian Arab Republic 
+Turks and Caicos Islands 
+Togo 
+Tokelau 
+Trinidad and Tobago 
+Tuvalu 
+Tanzania, United Republic of 
+United States Minor Outlying Islands 
+Holy See (Vatican City State) 
+Saint Vincent and the Grenadines 
+Venezuela, Bolivarian Republic of 
+Virgin Islands, British 
+Virgin Islands, U.S. 
+Wallis and Futuna 

vercel.json

@@ -1,8 +1,11 @@
 {
     "rewrites": [
-        { "source": "/(.*)", "destination": "/api/api" }
+        {
+            "source": "/(.*)",
+            "destination": "/api/api"
+        }
     ],
     "regions": [
         "syd1"
     ]
-}
+}