Starter code for async web chapter.

Author: mikeckennedy

Diff for: .gitignore

@@ -127,3 +127,10 @@ src/09-built-on-asyncio/.idea/09-built-on-asyncio.iml
 src/09-built-on-asyncio/.idea/misc.xml
 src/09-built-on-asyncio/.idea/modules.xml
 src/09-built-on-asyncio/.idea/workspace.xml
+src/10-async-web/.idea/10-async-web.iml
+src/10-async-web/.idea/misc.xml
+src/10-async-web/.idea/modules.xml
+src/10-async-web/.idea/webResources.xml
+src/10-async-web/.idea/workspace.xml
+src/10-async-web/.idea/dictionaries/mkennedy.xml
+Project_Default.xml

Diff for: src/10-async-web/.idea/vcs.xml

@@ -0,0 +1,34 @@
+import flask
+from views import city_api
+from views import home
+from config import settings
+import services.weather_service
+import services.sun_service
+import services.location_service
+
+app = flask.Flask(__name__)
+is_debug = True
+
+app.register_blueprint(home.blueprint)
+app.register_blueprint(city_api.blueprint)
+
+
+def configure_app():
+    mode = 'dev' if is_debug else 'prod'
+    data = settings.load(mode)
+
+    services.weather_service.global_init(data.get('weather_key'))
+    services.sun_service.use_cached_data = data.get('use_cached_data')
+    services.location_service.use_cached_data = data.get('use_cached_data')
+
+    print("Using cached data? {}".format(data.get('use_cached_data')))
+
+
+def run_web_app():
+    app.run(debug=is_debug, port=5001)
+
+
+configure_app()
+
+if __name__ == '__main__':
+    run_web_app()

Diff for: src/10-async-web/acityscape_api/app.py

@@ -0,0 +1,5 @@
+{
+  "dev": true,
+  "use_cached_data": false,
+  "weather_key": "684e93644281bf1398569ccf91aca62d"
+}

Diff for: src/10-async-web/acityscape_api/config/dev.json

@@ -0,0 +1,5 @@
+{
+  "dev": false,
+  "use_cached_data": false,
+  "weather_key": "684e93644281bf1398569ccf91aca62d"
+}

Diff for: src/10-async-web/acityscape_api/config/prod.json

@@ -0,0 +1,11 @@
+import os
+import json
+
+
+def load(mode='dev') -> dict:
+    file = os.path.join(os.path.dirname(__file__), f"{mode}.json")
+    if not os.path.exists(file):
+        raise Exception(f"Config not found for {mode}.")
+
+    with open(file, 'r', encoding='utf-8') as fin:
+        return json.load(fin)

Diff for: src/10-async-web/acityscape_api/config/settings.py

@@ -0,0 +1,5 @@
+# Web framework requirements
+flask
+
+# Calling services requirements
+requests

Diff for: src/10-async-web/acityscape_api/requirements.txt

@@ -0,0 +1,27 @@
+import random
+import time
+from typing import Tuple
+import requests
+
+use_cached_data = False
+
+measured_latency_in_sec = [
+    0.28844, 0.334694, 0.33468, 0.343911, 0.339515, 0.344329, 0.341594, 0.352366,
+    0.535646, 0.527148, 0.533472, 0.53351, 0.523462]
+
+
+def get_lat_long(zip_code: str, country: str) -> Tuple[float, float]:
+    key = f'{zip_code}, {country}'
+    url = f'http://www.datasciencetoolkit.org/street2coordinates/{key.replace(" ", "+")}'
+
+    if use_cached_data:
+        time.sleep(random.choice(measured_latency_in_sec))
+        return 45.50655, -122.733888
+    else:
+        resp = requests.get(url)
+        resp.raise_for_status()
+
+        data = resp.json()
+
+        city_data = data.get(f'{zip_code}, {country}', dict())
+        return city_data.get('latitude', 0.00), city_data.get('longitude', 0.00)

Diff for: src/10-async-web/acityscape_api/services/event_service.py

@@ -0,0 +1,39 @@
+import datetime
+import random
+import time
+
+import requests
+
+measured_latency_in_sec = [0.399203, 0.7046, 0.422959, 0.741911, 0.404674]
+use_cached_data = False
+
+
+def for_today(latitude: float, longitude: float) -> dict:
+    url = f'https://api.sunrise-sunset.org/json?lat={latitude}&lng={longitude}'
+
+    if use_cached_data:  # Set in config/dev.json or config/prod.json
+        time.sleep(random.choice(measured_latency_in_sec))
+        return {'sunrise': '06:04:09 AM', 'sunset': '08:28:48 PM', 'solar_noon': '01:16:28 PM',
+                'day_length': '14:24:39', 'civil_twilight_begin': '05:31:10 AM', 'civil_twilight_end': '09:01:47 PM',
+                'nautical_twilight_begin': '04:49:54 AM', 'nautical_twilight_end': '09:43:03 PM',
+                'astronomical_twilight_begin': '04:03:13 AM', 'astronomical_twilight_end': '10:29:44 PM'}
+    else:
+        resp = requests.get(url)
+        resp.raise_for_status()
+
+        sun_data = resp.json().get('results', {})
+        for k, v in list(sun_data.items()):
+            if 'AM' not in v and 'PM' not in v:
+                continue
+
+            sun_data[k] = datetime.datetime.strftime(__utc_to_local(v), '%I:%M:%S %p')
+
+        return sun_data
+
+
+def __utc_to_local(date_text: str) -> datetime.datetime:
+    # Not perfect, but works most of the time.
+    utc = datetime.datetime.strptime(date_text, '%I:%M:%S %p')
+    now_timestamp = time.time()
+    offset = datetime.datetime.fromtimestamp(now_timestamp) - datetime.datetime.utcfromtimestamp(now_timestamp)
+    return utc + offset

Diff for: src/10-async-web/acityscape_api/services/location_service.py

@@ -0,0 +1,16 @@
+import requests
+
+__api_key = ''
+
+
+def global_init(api_key: str):
+    global __api_key
+    __api_key = api_key
+
+
+def get_current(zip_code: str, country_code: str) -> dict:
+    url = f'https://api.openweathermap.org/data/2.5/weather?zip={zip_code},{country_code}&appid={__api_key}'
+    resp = requests.get(url)
+    resp.raise_for_status()
+
+    return resp.json()

Diff for: src/10-async-web/acityscape_api/services/sun_service.py

@@ -0,0 +1,21 @@
+import flask
+from services import weather_service, sun_service, location_service
+
+blueprint = flask.blueprints.Blueprint(__name__, __name__)
+
+
+@blueprint.route('/api/weather/<zip_code>/<country>', methods=['GET'])
+def weather(zip_code: str, country: str):
+    weather_data = weather_service.get_current(zip_code, country)
+    if not weather_data:
+        flask.abort(404)
+    return flask.jsonify(weather_data)
+
+
+@blueprint.route('/api/sun/<zip_code>/<country>', methods=['GET'])
+def sun(zip_code: str, country: str):
+    lat, long = location_service.get_lat_long(zip_code, country)
+    sun_data = sun_service.for_today(lat, long)
+    if not sun_data:
+        flask.abort(404)
+    return flask.jsonify(sun_data)

Diff for: src/10-async-web/acityscape_api/services/weather_service.py

@@ -0,0 +1,15 @@
+import flask
+
+blueprint = flask.blueprints.Blueprint(__name__, __name__)
+
+
+@blueprint.route('/')
+def index():
+    return "Welcome to the city_scape API. " \
+           "Use /api/sun/[zipcode]/[country code (e.g. us)] and" \
+           "/api/weather/[zipcode]/[country code (e.g. us)] for API calls."
+
+
+@blueprint.errorhandler(404)
+def not_found(_):
+    return flask.Response("The page was not found.", status=404)

Diff for: src/10-async-web/acityscape_api/views/city_api.py

@@ -0,0 +1,34 @@
+import flask
+from views import city_api
+from views import home
+from config import settings
+import services.weather_service
+import services.sun_service
+import services.location_service
+
+app = flask.Flask(__name__)
+is_debug = True
+
+app.register_blueprint(home.blueprint)
+app.register_blueprint(city_api.blueprint)
+
+
+def configure_app():
+    mode = 'dev' if is_debug else 'prod'
+    data = settings.load(mode)
+
+    services.weather_service.global_init(data.get('weather_key'))
+    services.sun_service.use_cached_data = data.get('use_cached_data')
+    services.location_service.use_cached_data = data.get('use_cached_data')
+
+    print("Using cached data? {}".format(data.get('use_cached_data')))
+
+
+def run_web_app():
+    app.run(debug=is_debug, port=5001)
+
+
+configure_app()
+
+if __name__ == '__main__':
+    run_web_app()

Diff for: src/10-async-web/acityscape_api/views/home.py

@@ -0,0 +1,5 @@
+{
+  "dev": true,
+  "use_cached_data": false,
+  "weather_key": "684e93644281bf1398569ccf91aca62d"
+}

Diff for: src/10-async-web/cityscape_api/app.py

@@ -0,0 +1,5 @@
+{
+  "dev": false,
+  "use_cached_data": false,
+  "weather_key": "684e93644281bf1398569ccf91aca62d"
+}

Diff for: src/10-async-web/cityscape_api/config/dev.json

@@ -0,0 +1,11 @@
+import os
+import json
+
+
+def load(mode='dev') -> dict:
+    file = os.path.join(os.path.dirname(__file__), f"{mode}.json")
+    if not os.path.exists(file):
+        raise Exception(f"Config not found for {mode}.")
+
+    with open(file, 'r', encoding='utf-8') as fin:
+        return json.load(fin)

Diff for: src/10-async-web/cityscape_api/config/prod.json

@@ -0,0 +1,5 @@
+# Web framework requirements
+flask
+
+# Calling services requirements
+requests

Diff for: src/10-async-web/cityscape_api/config/settings.py

@@ -0,0 +1,27 @@
+import random
+import time
+from typing import Tuple
+import requests
+
+use_cached_data = False
+
+measured_latency_in_sec = [
+    0.28844, 0.334694, 0.33468, 0.343911, 0.339515, 0.344329, 0.341594, 0.352366,
+    0.535646, 0.527148, 0.533472, 0.53351, 0.523462]
+
+
+def get_lat_long(zip_code: str, country: str) -> Tuple[float, float]:
+    key = f'{zip_code}, {country}'
+    url = f'http://www.datasciencetoolkit.org/street2coordinates/{key.replace(" ", "+")}'
+
+    if use_cached_data:
+        time.sleep(random.choice(measured_latency_in_sec))
+        return 45.50655, -122.733888
+    else:
+        resp = requests.get(url)
+        resp.raise_for_status()
+
+        data = resp.json()
+
+        city_data = data.get(f'{zip_code}, {country}', dict())
+        return city_data.get('latitude', 0.00), city_data.get('longitude', 0.00)

Diff for: src/10-async-web/cityscape_api/requirements.txt

@@ -0,0 +1,39 @@
+import datetime
+import random
+import time
+
+import requests
+
+measured_latency_in_sec = [0.399203, 0.7046, 0.422959, 0.741911, 0.404674]
+use_cached_data = False
+
+
+def for_today(latitude: float, longitude: float) -> dict:
+    url = f'https://api.sunrise-sunset.org/json?lat={latitude}&lng={longitude}'
+
+    if use_cached_data:  # Set in config/dev.json or config/prod.json
+        time.sleep(random.choice(measured_latency_in_sec))
+        return {'sunrise': '06:04:09 AM', 'sunset': '08:28:48 PM', 'solar_noon': '01:16:28 PM',
+                'day_length': '14:24:39', 'civil_twilight_begin': '05:31:10 AM', 'civil_twilight_end': '09:01:47 PM',
+                'nautical_twilight_begin': '04:49:54 AM', 'nautical_twilight_end': '09:43:03 PM',
+                'astronomical_twilight_begin': '04:03:13 AM', 'astronomical_twilight_end': '10:29:44 PM'}
+    else:
+        resp = requests.get(url)
+        resp.raise_for_status()
+
+        sun_data = resp.json().get('results', {})
+        for k, v in list(sun_data.items()):
+            if 'AM' not in v and 'PM' not in v:
+                continue
+
+            sun_data[k] = datetime.datetime.strftime(__utc_to_local(v), '%I:%M:%S %p')
+
+        return sun_data
+
+
+def __utc_to_local(date_text: str) -> datetime.datetime:
+    # Not perfect, but works most of the time.
+    utc = datetime.datetime.strptime(date_text, '%I:%M:%S %p')
+    now_timestamp = time.time()
+    offset = datetime.datetime.fromtimestamp(now_timestamp) - datetime.datetime.utcfromtimestamp(now_timestamp)
+    return utc + offset

Diff for: src/10-async-web/cityscape_api/services/event_service.py

@@ -0,0 +1,16 @@
+import requests
+
+__api_key = ''
+
+
+def global_init(api_key: str):
+    global __api_key
+    __api_key = api_key
+
+
+def get_current(zip_code: str, country_code: str) -> dict:
+    url = f'https://api.openweathermap.org/data/2.5/weather?zip={zip_code},{country_code}&appid={__api_key}'
+    resp = requests.get(url)
+    resp.raise_for_status()
+
+    return resp.json()

Diff for: src/10-async-web/cityscape_api/services/location_service.py

@@ -0,0 +1,21 @@
+import flask
+from services import weather_service, sun_service, location_service
+
+blueprint = flask.blueprints.Blueprint(__name__, __name__)
+
+
+@blueprint.route('/api/weather/<zip_code>/<country>', methods=['GET'])
+def weather(zip_code: str, country: str):
+    weather_data = weather_service.get_current(zip_code, country)
+    if not weather_data:
+        flask.abort(404)
+    return flask.jsonify(weather_data)
+
+
+@blueprint.route('/api/sun/<zip_code>/<country>', methods=['GET'])
+def sun(zip_code: str, country: str):
+    lat, long = location_service.get_lat_long(zip_code, country)
+    sun_data = sun_service.for_today(lat, long)
+    if not sun_data:
+        flask.abort(404)
+    return flask.jsonify(sun_data)

Diff for: src/10-async-web/cityscape_api/services/sun_service.py

@@ -0,0 +1,15 @@
+import flask
+
+blueprint = flask.blueprints.Blueprint(__name__, __name__)
+
+
+@blueprint.route('/')
+def index():
+    return "Welcome to the city_scape API. " \
+           "Use /api/sun/[zipcode]/[country code (e.g. us)] and" \
+           "/api/weather/[zipcode]/[country code (e.g. us)] for API calls."
+
+
+@blueprint.errorhandler(404)
+def not_found(_):
+    return flask.Response("The page was not found.", status=404)