Upgrade deps, config GH actions, add mergify, improve tests

Author: maylonpedroso

.env.example

@@ -1,9 +1,10 @@
 # Environment variables for appointment-reminders-flask
 
 # App settings
-export DATABASE_URL=postgres://someuser:withsomepassword@localhost:5432/appointments
+export DATABASE_URI=
 export SECRET_KEY=asupersecr3tkeyshouldgo
-export CELERY_URL=redis://localhost:6379
+export CELERY_BROKER_URL=redis://localhost:6379
+export CELERY_RESULT_BACKEND=redis://localhost:6379
 
 # Twilio settings
 export TWILIO_ACCOUNT_SID=ACXXXXXXXXXXXXXXXXX

.github/workflows/flask.yml

@@ -0,0 +1,35 @@
+name: Flask
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+        platform: [windows-latest, macos-latest, ubuntu-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Run Linter
+      run: |
+        flake8
+    - name: Run Tests
+      run: |
+        cp .env.example .env
+        python runtests.py

.gitignore

@@ -59,3 +59,4 @@ target/
 
 .env
 /venv
+*.sqlite

.mergify.yml

@@ -0,0 +1,8 @@
+pull_request_rules:
+  - name: automatic merge for Dependabot pull requests
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+      - status-success=build
+    actions:
+      merge:
+        method: squash

.travis.yml

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Twilio Inc.
+Copyright (c) 2021 Twilio Inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,5 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+SOFTWARE.

LICENSE

@@ -21,47 +21,54 @@ This project is built using the [Flask](http://flask.pocoo.org/) web framework.
 
 To run the app locally, first clone this repository and `cd` into its directory. Then:
 
-1. Create a new virtual environment:
-    - If using vanilla [virtualenv](https://virtualenv.pypa.io/en/latest/):
+1. Create and activate a new python3 virtual environment.
 
-        ```bash
-        $ virtualenv venv
-        $ source venv/bin/activate
-        ```
-
-    - If using [virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/):
+    ```bash
+    python3 -m venv venv
+    source venv/bin/activate
+    ```
 
-        ```bash
-        $ mkvirtualenv appointment-reminders
-        ```
 
-1. Install the requirements:
+1. Install the requirements using [pip](https://pip.pypa.io/en/stable/installing/).
 
     ```bash
-    $ pip install -r requirements.txt
+    pip install -r requirements.txt
     ```
 
-1. Start a local PostgreSQL database and create a database called `appointments`:
-    - If on a Mac, we recommend [Postgres.app](http://postgresapp.com/). After install, open psql and run `CREATE DATABASE appointments;`
-    - If Postgres is already installed locally, you can just run `createdb appointments` from a terminal
+1. Copy the `.env.example` file to `.env` and add the following values. Be sure to replace the placeholders and connection string with real information.
 
-1. Copy the `.env_example` file to `.env`, and edit it to include your credentials for the Twilio API (found at https://www.twilio.com/user/account/voice) and your local Postgres database
-1. Run `source .env` to apply the environment variables (or even better, use [autoenv](https://github.com/kennethreitz/autoenv))
+   ```
+   SECRET_KEY = 'your_authy_secret_key'
+   
+   TWILIO_ACCOUNT_SID = '[your_twilio_account_sid]'
+   TWILIO_AUTH_TOKEN = '[your_twilio_auth_token]'
+   TWILIO_NUMBER = '[your_twilio_phone_number]'
+   ```
 
-1. Run the migrations with:
+1. Create Flask application variables
+   
+   ```bash
+   export FLASK_APP=reminders 
+   export FLASK_ENV=development
+   ```
 
-    ```bash
-    $ alembic upgrade +1
-    ```
-    Note: If you have a local postgres installation where you access without password add this line to your `pg_hba.conf` file, *JUST FOR DEVELOPMENT, DO NOT USE THIS IN PRODUCTION*:
-    `host    all             YOUR_USER         127.0.0.1/32            trust`
+1. Run the migrations.
+
+   ```bash
+   flask db upgrade
+   ```
 
-1. Start a [redis](http://redis.io/) server to be our Celery broker. If on a Mac, we recommend installing redis through [homebrew](http://brew.sh/)
+1. Start a [redis](http://redis.io/) server to be our Celery broker. 
+   If on a Mac, we recommend installing redis through [homebrew](http://brew.sh/)
+   If you already have docker installed in your system an easy way of get redis running is:
+   ```bash
+   docker run -d -p 6379:6379 redis:latest
+   ```
 
 1. Start the development server:
 
     ```bash
-    $ python runapp.py
+    flask run
     ```
 
 You can now access the application at
@@ -72,23 +79,28 @@ you must also start a separate Celery worker process.
 1. Start a new terminal session, `cd` into the repository, and active your
    `appointment-reminders` virtualenv
 
+1. Activate Flask development environment
+   
+   ```bash
+   export FLASK_ENV=development
+   ```
+
 1. Start the Celery worker:
 
     ```bash
-    $ celery -A reminders.celery worker -l info
+    celery -A tasks.celery worker -l info
     ```
 
 Celery will now send SMS reminders for any new appointments you create through
 the web app.
 
 ## Run the tests
 
-You can run the tests locally through [pytest](http://pytest.org/).
-
-Follow the instructions in the [Local Development](#local-development) section above, and then run:
+You can run the tests locally. Follow the instructions in the
+[Local Development](#local-development) section above, and then run:
 
 ```bash
-$ py.test --cov tests
+python runtests.py
 ```
 
 You can then view the results with `coverage report` or build an HTML report with `coverage html`.

README.md

@@ -1,7 +1,11 @@
 import flask
-import flask.ext.sqlalchemy
+from flask_migrate import Migrate
+
+from flask_sqlalchemy import SQLAlchemy
 
 from celery import Celery
+
+from config import config_classes
 from views.appointment import (
     AppointmentFormResource,
     AppointmentResourceCreate,
@@ -11,7 +15,6 @@
 
 
 class Route(object):
-
     def __init__(self, url, route_name, resource):
         self.url = url
         self.route_name = route_name
@@ -21,35 +24,35 @@ def __init__(self, url, route_name, resource):
 handlers = [
     Route('/', 'appointment.index', AppointmentResourceIndex),
     Route('/appointment', 'appointment.create', AppointmentResourceCreate),
-    Route('/appointment/<int:id>/delete',
-          'appointment.delete', AppointmentResourceDelete),
+    Route(
+        '/appointment/<int:id>/delete', 'appointment.delete', AppointmentResourceDelete
+    ),
     Route('/appointment/new', 'appointment.new', AppointmentFormResource),
 ]
 
 
 class Application(object):
-
-    def __init__(self, routes, config, debug=True):
+    def __init__(self, routes, environment):
         self.flask_app = flask.Flask(__name__)
         self.routes = routes
-        self.debug = debug
-        self._configure_app(config)
+        self._configure_app(environment)
         self._set_routes()
 
     def celery(self):
-        app = self.flask_app
-        celery = Celery(app.import_name, broker=app.config[
-                        'CELERY_BROKER_URL'])
-        celery.conf.update(app.config)
+        celery = Celery(
+            self.flask_app.import_name, broker=self.flask_app.config['CELERY_BROKER_URL']
+        )
+        celery.conf.update(self.flask_app.config)
 
         TaskBase = celery.Task
 
         class ContextTask(TaskBase):
             abstract = True
 
             def __call__(self, *args, **kwargs):
-                with app.app_context():
+                with self.flask_app.app_context():
                     return TaskBase.__call__(self, *args, **kwargs)
+
         celery.Task = ContextTask
 
         return celery
@@ -60,25 +63,7 @@ def _set_routes(self):
             self.flask_app.add_url_rule(route.url, view_func=app_view)
 
     def _configure_app(self, env):
-        celery_url = env.get('CELERY_URL')
-
-        self.flask_app.config[
-            'SQLALCHEMY_DATABASE_URI'] = env.get('DATABASE_URL')
-
-        self.flask_app.config['CELERY_BROKER_URL'] = env.get(
-            'REDIS_URL', celery_url)
-        self.flask_app.config['CELERY_RESULT_BACKEND'] = env.get(
-            'REDIS_URL', celery_url)
-
-        self.flask_app.config['TWILIO_ACCOUNT_SID'] = env.get(
-            'TWILIO_ACCOUNT_SID')
-        self.flask_app.config['TWILIO_AUTH_TOKEN'] = env.get(
-            'TWILIO_AUTH_TOKEN')
-        self.flask_app.config['TWILIO_NUMBER'] = env.get('TWILIO_NUMBER')
-
-        self.flask_app.secret_key = env.get('SECRET_KEY')
-
-        self.db = flask.ext.sqlalchemy.SQLAlchemy(self.flask_app)
-
-    def start_app(self):
-        self.flask_app.run(debug=self.debug)
+        self.flask_app.config.from_object(config_classes[env])
+        self.db = SQLAlchemy(self.flask_app)
+        self.migrate = Migrate()
+        self.migrate.init_app(self.flask_app, self.db)

application.py

@@ -0,0 +1,18 @@
+[tool.black]
+line-length = 90
+target-version = ['py36']
+include = '\.pyi?$'
+exclude = '''
+
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.tox
+    | \.venv
+    | _build
+    | build
+    | dist
+  )/
+)
+'''

black.toml

@@ -0,0 +1,42 @@
+import os
+
+from dotenv import load_dotenv
+
+load_dotenv()
+
+basedir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
+
+
+class DefaultConfig(object):
+    SECRET_KEY = os.environ.get('SECRET_KEY')
+    DEBUG = False
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URI')
+    TWILIO_ACCOUNT_SID = os.environ.get('TWILIO_ACCOUNT_SID')
+    TWILIO_AUTH_TOKEN = os.environ.get('TWILIO_AUTH_TOKEN')
+    TWILIO_NUMBER = os.environ.get('TWILIO_NUMBER')
+
+
+class DevelopmentConfig(DefaultConfig):
+    DEBUG = True
+    SECRET_KEY = os.environ.get('SECRET_KEY', 'secret-key')
+    SQLALCHEMY_DATABASE_URI = (
+        os.environ.get('DATABASE_URI')
+        or f"sqlite:///{os.path.join(basedir, 'dev.sqlite')}"
+    )
+
+
+class TestConfig(DefaultConfig):
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///:memory:'
+    PRESERVE_CONTEXT_ON_EXCEPTION = False
+    DEBUG = True
+    TESTING = True
+    WTF_CSRF_ENABLED = False
+    SERVER_NAME = 'server.test'
+
+
+config_classes = {
+    'testing': TestConfig,
+    'development': DevelopmentConfig,
+    'production': DefaultConfig,
+}

config/__init__.py

@@ -0,0 +1,5 @@
+from flask_sqlalchemy import SQLAlchemy
+from flask_migrate import Migrate
+
+db = SQLAlchemy()
+migrate = Migrate()