advisory endpoint

Author: Kevin Le

.gitignore

@@ -0,0 +1,134 @@
+api.log
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.aws-sam/
+.idea/

README.md

@@ -0,0 +1,48 @@
+# Smartraveller API
+
+A simple API for travel advisories published by the Australian Government on [Smartraveller](https://www.smartraveller.gov.au/).
+
+**This is not an official API. Visit the Smartraveller website for latest information**
+
+## Locally running
+```
+pip install -r requirements.txt
+python wsgi.py
+```
+
+## Deployment 
+
+Available at https://smartraveller.api.kevle.xyz/
+
+OR
+
+[![Deploy to Vercel](https://camo.githubusercontent.com/f209ca5cc3af7dd930b6bfc55b3d7b6a5fde1aff/68747470733a2f2f76657263656c2e636f6d2f627574746f6e)](https://vercel.com/import/project?template=https://github.com/kevinle-1/smartraveller-api)
+
+## Endpoint(s)
+
+### GET /advisory
+
+Fetches an advice summary for a country. 
+
+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. 
+
+#### Example Response 
+
+```
+{
+  "advisory": "Exercise normal safety precautions",
+  "level": 1,
+  "country": "Spain",
+  "alpha_2": "ES",
+  "official_name": "Kingdom of Spain"
+}
+```
+
+## Copyright
+
+Smartraveller material accessed is provided under the latest [Creative Commons Attribution licence](creativecommons.org/licenses/by/4.0/). 

api/api.py

@@ -0,0 +1,42 @@
+import json
+import pycountry
+from flask import Flask, request, Response
+from api.smartraveller.advisory import get_overall_advisory
+import logging
+
+app = Flask(__name__, static_url_path='')
+@app.route('/')
+def index(): 
+    return '<h1>Smartraveller API</h1> \
+            <p>Smartraveller material accessed is provided under the latest Creative Commons Attribution licence.<p/> \
+            <a href="https://www.smartraveller.gov.au/">Smartraveller</a>'
+
+@app.route('/advisory')
+def advisory():
+    country_query = request.args.get('country')
+    if country_query:
+        try:
+            country = pycountry.countries.lookup(country_query)
+        except Exception as e:
+            logging.error(e)
+            country = None
+        
+        if country is not None:
+            advisory = get_overall_advisory()
+            
+            country_query = country.name.lower().replace(" ", "-")
+            logging.debug(f"Querying for country: {country_query}")
+            
+            advisory["country"] = country.name
+            advisory["alpha_2"] = country.alpha_2
+            advisory["official_name"] = country.official_name
+            
+            response = Response(json.dumps(advisory))
+            response.headers['Cache-Control'] = 's-maxage=3600' # Vercel cache for 1 hour
+            response.headers['Content-Type'] = 'application/json'
+            
+            return response
+        else:
+            return "Invalid country", 404
+    else:
+        return "Missing country query parameter", 400

api/smartraveller/advisory.py

@@ -0,0 +1,27 @@
+import requests
+import time
+from bs4 import BeautifulSoup
+
+advisory_level ={
+    "Exercise normal safety precautions": 1,
+    "Exercise a high degree of caution": 2,
+    "Reconsider your need to travel": 3,
+    "Do not travel": 4
+}
+
+def get_overall_advisory() -> dict:
+    country = "austria"
+    
+    html = requests.get(f'https://www.smartraveller.gov.au/destinations/{country}').content
+    site = BeautifulSoup(html, 'html.parser')
+    
+    advisory_block = site.findAll('div', { 'class': 'views-field views-field-field-overall-advice-level'})
+    advisory = advisory_block[0].find('strong').getText()
+    
+    return {
+        "advisory": advisory,
+        "level": advisory_level[advisory]
+    }
+
+if __name__ == "__main__":
+    print(get_overall_advisory())

requirements.txt

@@ -0,0 +1,3 @@
+requests==2.28.2
+Flask==2.2.3
+beautifulsoup4==4.11.2

vercel.json

@@ -0,0 +1,5 @@
+{
+    "rewrites": [
+        { "source": "/(.*)", "destination": "/api/api" }
+    ]
+}

wsgi.py

@@ -0,0 +1,4 @@
+from api.api import app
+
+if __name__ == '__main__':
+    app.run(host='0.0.0.0')