Refactor first three examples into modules. This will be a more sustainable structure going forward.

Change-Id: Ia601f0d4ab626501fdca2f1c4583287153b8ab70

Author: AndrewMBurke

.gitignore

@@ -15,4 +15,6 @@ Dockerfile
 *.json
 *.sqlite
 
-*/__pycache__/*
+# Ignore any Python generated files.
+__pycache__/
+*.py[cod]

flask/01-basic-app/config.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+"""The Flask server configuration."""
+
+import os
+
+
+class Config(object):
+    # Note: A secret key is included in the sample so that it works.
+    # If you use this code in your application, replace this with a truly secret
+    # key. See https://flask.palletsprojects.com/quickstart/#sessions.
+    SECRET_KEY = os.environ.get(
+        'SECRET_KEY') or "REPLACE ME - this value is here as a placeholder."

flask/01-basic-app/main.py

@@ -5,55 +5,20 @@
 # use this file except in compliance with the License. You may obtain a copy of
 # the License at
 #
-#     https://www.apache.org/licenses/LICENSE-2.0
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
-"""The Flask server application. Defines routes.
+"""Entry point for the Flask server.
 
-Ensure that you select an approprate run strategy at the bottom of this file.
-"""
+Loads the webapp module and starts the server."""
 
-import flask
+from webapp import app
 import os
 
-# Instantiate the Flask application.
-app = flask.Flask(__name__)
-
-# Note: A secret key is included in the sample so that it works. If you use this
-# code in your application, replace this with a truly secret key. See
-# https://flask.palletsprojects.com/quickstart/#sessions.
-app.secret_key = "REPLACE ME - this value is here as a placeholder."
-
-
-@app.route("/")
-def index():
-    """
-    Render the index page from the "index.html" template. This is meant to act
-    as a facsimile of a company's home page. The Add-on Discovery URL should be
-    set to the /classroom-addon route below.
-    """
-
-    return flask.render_template(
-        "index.html", message="You've reached the index page.")
-
-
-@app.route("/classroom-addon")
-def classroom_addon():
-    """
-    Renders the addon discovery page from the "addon-discovery.html" template.
-    This is meant to be the landing page when opening the web app in the
-    Classroom add-on iframe.
-    """
-
-    return flask.render_template(
-        "addon-discovery.html",
-        message="You've reached the addon discovery page.")
-
-
 if __name__ == "__main__":
     # You have several options for running the web server.
 
@@ -62,18 +27,20 @@ def classroom_addon():
     # OAuthlib's HTTPs verification.
 
     # Important: When running in production *do not* leave this option enabled.
-    os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"
+    # os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"
 
     # Run the application on a local server, defaults to http://localhost:5000.
     # Note: the OAuth flow requires a TLD, *not* an IP address; "localhost" is
     # acceptable, but http://127.0.0.1 is not.
-    app.run(debug=True)
+    # app.run(debug=True)
 
     ### OPTION 2: Secure localhost
     # Run the application over HTTPs with a locally stored certificate and key.
     # Defaults to https://localhost:5000.
-    # app.run(host="localhost",
-    #   ssl_context=("localhost.pem", "localhost-key.pem"), debug=True)
+    app.run(
+        host="localhost",
+        ssl_context=("localhost.pem", "localhost-key.pem"),
+        debug=True)
 
     ### OPTION 3: Production- or cloud-ready server
     # Start a Gunicorn server, which is appropriate for use in production or a

flask/01-basic-app/webapp/__init__.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+"""Initialize the webapp module.
+
+Starts the flask server and loads the config."""
+
+from flask import Flask
+import config
+
+app = Flask(__name__)
+app.config.from_object(config.Config)
+
+from webapp import routes

flask/01-basic-app/webapp/routes.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+"""Defines all routes for the Flask server."""
+
+from webapp import app
+import flask
+
+
+@app.route("/")
+def index():
+    """
+    Render the index page from the "index.html" template. This is meant to act
+    as a facsimile of a company's home page. The Add-on Discovery URL should be
+    set to the /classroom-addon route below.
+    """
+
+    return flask.render_template(
+        "index.html", message="You've reached the index page.")
+
+
+@app.route("/classroom-addon")
+def classroom_addon():
+    """
+    Renders the addon discovery page from the "addon-discovery.html" template.
+    This is meant to be the landing page when opening the web app in the
+    Classroom add-on iframe.
+    """
+
+    return flask.render_template(
+        "addon-discovery.html",
+        message="You've reached the addon discovery page.")