diff --git a/.gitignore b/.gitignore index ec9d63a..9df399d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ # Configs -config/service-acct.json -config/db.py +priceybot2/config/service-acct.json +priceybot2/config/db.py # Logs *.log diff --git a/__pycache__/__init__.cpython-310.pyc b/__pycache__/__init__.cpython-310.pyc deleted file mode 100644 index 35d6fc6..0000000 Binary files a/__pycache__/__init__.cpython-310.pyc and /dev/null differ diff --git a/__pycache__/auth.cpython-310.pyc b/__pycache__/auth.cpython-310.pyc deleted file mode 100644 index 9a55c04..0000000 Binary files a/__pycache__/auth.cpython-310.pyc and /dev/null differ diff --git a/__pycache__/main.cpython-310.pyc b/__pycache__/main.cpython-310.pyc deleted file mode 100644 index b4cce96..0000000 Binary files a/__pycache__/main.cpython-310.pyc and /dev/null differ diff --git a/__pycache__/models.cpython-310.pyc b/__pycache__/models.cpython-310.pyc deleted file mode 100644 index c92bc2e..0000000 Binary files a/__pycache__/models.cpython-310.pyc and /dev/null differ diff --git a/migrations/README b/migrations/README new file mode 100644 index 0000000..0e04844 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 0000000..ec9d45c --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic,flask_migrate + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..89f80b2 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,110 @@ +import logging +from logging.config import fileConfig + +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except TypeError: + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option('sqlalchemy.url', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=get_metadata(), literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/__init__.py b/priceybot2/__init__.py similarity index 92% rename from __init__.py rename to priceybot2/__init__.py index 3c60dd7..48956f3 100644 --- a/__init__.py +++ b/priceybot2/__init__.py @@ -1,17 +1,21 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_login import LoginManager +from flask_migrate import Migrate from .config import db as db_config db = SQLAlchemy() +migrate = Migrate() def create_app(): app = Flask(__name__) - app.config['SECRET_KEY'] = '//' app.config["SQLALCHEMY_DATABASE_URI"] = db_config.SQL_URI + db.init_app(app) + migrate.init_app(app, db) + login_manager = LoginManager() login_manager.login_view = 'auth.login' login_manager.init_app(app) @@ -24,7 +28,6 @@ def create_app(): from . import models with app.app_context(): - print("Applying the DB models") db.create_all() # blueprint for auth routes in our app diff --git a/auth.py b/priceybot2/auth.py similarity index 100% rename from auth.py rename to priceybot2/auth.py diff --git a/chatbot.py b/priceybot2/chatbot.py similarity index 98% rename from chatbot.py rename to priceybot2/chatbot.py index 7369ed0..4a115a1 100644 --- a/chatbot.py +++ b/priceybot2/chatbot.py @@ -33,7 +33,7 @@ chatbot = Blueprint('chatbot', __name__) scopes = ['https://www.googleapis.com/auth/chat.bot'] -credentials = service_account.Credentials.from_service_account_file('./config/service-acct.json') +credentials = service_account.Credentials.from_service_account_file('./priceybot2/config/service-acct.json') # credentials, project_id = google.auth.default() credentials = credentials.with_scopes(scopes=scopes) chat = build('chat', 'v1', credentials=credentials) diff --git a/config/__init__.py b/priceybot2/config/__init__.py similarity index 100% rename from config/__init__.py rename to priceybot2/config/__init__.py diff --git a/config/db.py.sample b/priceybot2/config/db.py.sample similarity index 100% rename from config/db.py.sample rename to priceybot2/config/db.py.sample diff --git a/config/service-acct.json.sample b/priceybot2/config/service-acct.json.sample similarity index 100% rename from config/service-acct.json.sample rename to priceybot2/config/service-acct.json.sample diff --git a/main.py b/priceybot2/main.py similarity index 82% rename from main.py rename to priceybot2/main.py index e9d9d4e..fa47b75 100644 --- a/main.py +++ b/priceybot2/main.py @@ -12,4 +12,4 @@ def index(): @main.route('/profile') @login_required def profile(): - return render_template('profile.html', name=current_user.name, google_id=current_user.google_id) + return render_template('profile.html', name=current_user.name, google_id=current_user.google_id, is_admin=current_user.administrator) diff --git a/models.py b/priceybot2/models.py similarity index 84% rename from models.py rename to priceybot2/models.py index 15bbef0..8c20860 100644 --- a/models.py +++ b/priceybot2/models.py @@ -7,3 +7,5 @@ class User(UserMixin, db.Model): password = db.Column(db.String(100)) name = db.Column(db.String(1000)) google_id = db.Column(db.String(30), unique=True) + administrator = db.Column(db.Boolean, default=False) + diff --git a/templates/base.html b/priceybot2/templates/base.html similarity index 100% rename from templates/base.html rename to priceybot2/templates/base.html diff --git a/templates/home.html b/priceybot2/templates/home.html similarity index 100% rename from templates/home.html rename to priceybot2/templates/home.html diff --git a/templates/index.html b/priceybot2/templates/index.html similarity index 100% rename from templates/index.html rename to priceybot2/templates/index.html diff --git a/templates/login.html b/priceybot2/templates/login.html similarity index 100% rename from templates/login.html rename to priceybot2/templates/login.html diff --git a/priceybot2/templates/profile.html b/priceybot2/templates/profile.html new file mode 100644 index 0000000..b5ff5f4 --- /dev/null +++ b/priceybot2/templates/profile.html @@ -0,0 +1,9 @@ +{% extends "base.html" %} + +{% block content %} +

+ Welcome, {{ name }}!

+ Your google ID is {{ google_id }}

+ Admin?: {{ "yes" if is_admin else "no" }}

+

+{% endblock %} diff --git a/templates/signup.html b/priceybot2/templates/signup.html similarity index 100% rename from templates/signup.html rename to priceybot2/templates/signup.html diff --git a/requirements.txt b/requirements.txt index 8e8f6ab..19d9ce6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,3 +5,4 @@ google mysqlclient flask-login flask_sqlalchemy +Flask-Migrate diff --git a/templates/profile.html b/templates/profile.html deleted file mode 100644 index 12a799a..0000000 --- a/templates/profile.html +++ /dev/null @@ -1,8 +0,0 @@ -{% extends "base.html" %} - -{% block content %} -

- Welcome, {{ name }}!

- Your google ID is {{ google_id }} -

-{% endblock %}