added sqlalchemy schema and flask-migrate files

forms/app.py

@@ -7,6 +7,7 @@ import re
 
 import flask
 from flask import request, url_for, render_template, redirect, jsonify
+from flask.ext.sqlalchemy import SQLAlchemy
 
 import werkzeug.datastructures
 
@@ -16,7 +17,6 @@ from utils import crossdomain, request_wants_json, jsonerror
 import settings
 import log
 
-
 '''
 constants
 
@@ -58,6 +58,23 @@ forms_email_HASH -- has the confirmation email been confirmed?
 forms_counter_HASH -- the number of emails sent for this form
 
 '''
+DB = SQLAlchemy()
+class Form(DB.Model):
+    __tablename__ = 'forms'
+    id = DB.Column(DB.Integer, primary_key=True)
+    hash = DB.Column(DB.String(32), unique=True)
+    email = DB.Column(DB.String(120))
+    host = DB.Column(DB.String(300))
+    confirm_sent = DB.Column(DB.Boolean)
+    confirmed = DB.Column(DB.Boolean)
+    counter = DB.Column(DB.Integer)
+    def __init__(self, email, host):
+        self.hash = HASH(email, host)
+        self.email = email
+        self.host = host
+        self.confirm_sent = False
+        self.confirmed = False
+        self.counter = 0
 
 
 ''' 
@@ -369,6 +386,8 @@ def configure_routes(app):
 def create_app():
     app = flask.Flask(__name__)
     app.config.from_object(settings)
+
+    DB.init_app(app)
     configure_routes(app)
 
     @app.errorhandler(500)

forms/settings.py

@@ -3,8 +3,12 @@ import os
 # load a bunch of environment
 
 DEBUG = os.getenv('DEBUG') in ['True', 'true', '1', 'yes']
+if DEBUG:
+    SQLALCHEMY_ECHO = True
 
 NONCE_SECRET = os.getenv('NONCE_SECRET')
+SQLALCHEMY_DATABASE_URI = os.getenv('DATABASE_URL')
+
 REDIS_URL = os.getenv('REDISTOGO_URL') or os.getenv('REDISGREEN_URL') or 'http://localhost:6379'
 
 SERVICE_NAME = os.getenv('SERVICE_NAME') or 'Forms'

manage.py

@@ -1,12 +1,18 @@
 import re
 
 from flask.ext.script import Manager
+from flask.ext.migrate import Migrate, MigrateCommand
 
 from forms import create_app, app
 
 forms_app = create_app()
 manager = Manager(forms_app)
 
+
+# add flask-migrate commands
+Migrate(forms_app, app.DB)
+manager.add_command('db', MigrateCommand)
+
 @manager.command
 def run(port=5000):
     app.run(port=int(port))

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

migrations/alembic.ini

@@ -0,0 +1,45 @@
+# 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
+
+[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
+
+[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

migrations/env.py

@@ -0,0 +1,73 @@
+from __future__ import with_statement
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from logging.config import fileConfig
+
+# 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)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+from flask import current_app
+config.set_main_option('sqlalchemy.url', current_app.config.get('SQLALCHEMY_DATABASE_URI'))
+target_metadata = current_app.extensions['migrate'].db.metadata
+
+# 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 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)
+
+    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.
+
+    """
+    engine = engine_from_config(
+                config.get_section(config.config_ini_section),
+                prefix='sqlalchemy.',
+                poolclass=pool.NullPool)
+
+    connection = engine.connect()
+    context.configure(
+                connection=connection,
+                target_metadata=target_metadata
+                )
+
+    try:
+        with context.begin_transaction():
+            context.run_migrations()
+    finally:
+        connection.close()
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()
+

migrations/script.py.mako

@@ -0,0 +1,22 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision}
+Create Date: ${create_date}
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

migrations/versions/dc8c1be855c_.py

@@ -0,0 +1,36 @@
+"""empty message
+
+Revision ID: dc8c1be855c
+Revises: None
+Create Date: 2015-01-06 17:53:38.330924
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = 'dc8c1be855c'
+down_revision = None
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('forms',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('hash', sa.String(length=32), nullable=True),
+    sa.Column('email', sa.String(length=120), nullable=True),
+    sa.Column('host', sa.String(length=300), nullable=True),
+    sa.Column('confirm_sent', sa.Boolean(), nullable=True),
+    sa.Column('confirmed', sa.Boolean(), nullable=True),
+    sa.Column('counter', sa.Integer(), nullable=True),
+    sa.PrimaryKeyConstraint('id'),
+    sa.UniqueConstraint('hash')
+    )
+    ### end Alembic commands ###
+
+
+def downgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('forms')
+    ### end Alembic commands ###

requirements.txt

@@ -1,6 +1,8 @@
 flask
 flask-script
 redis
+flask-sqlalchemy
 requests==2.0.0
 paste
-gunicorn
+gunicorn
+psycopg2