Initial commit

Author: michaelbukachi

.gitignore

@@ -0,0 +1,3 @@
+.idea
+venv
+*.log

README.md

@@ -0,0 +1,7 @@
+## api
+
+### Project Setup
+
+1. `pip install -r requirements.txt`
+2. `chmod +x unit-tests.sh`
+3. `./unit-tests.sh`

app/__init__.py

@@ -0,0 +1,46 @@
+import click
+from werkzeug.middleware.proxy_fix import ProxyFix
+
+from .factory import Factory
+
+
+def create_app(environment='development'):
+    f = Factory(environment)
+    f.set_flask()
+    f.set_db()
+    f.set_migration()
+    f.set_api()
+
+    # from models import Example
+
+    app = f.flask
+
+    from .views import sample_page
+
+    app.register_blueprint(sample_page, url_prefix='/views')
+
+    if app.config['TESTING']:  # pragma: no cover
+        # Setup app for testing
+        @app.before_first_request
+        def initialize_app():
+            pass
+
+    @app.after_request
+    def after_request(response):
+        response.headers.add('Access-Control-Allow-Origin', '*')
+        response.headers.add('Access-Control-Allow-Headers',
+                             'Content-Type,Authorization')
+        response.headers.add('Access-Control-Allow-Methods',
+                             'GET,PUT,POST,DELETE')
+
+        return response
+
+    app.wsgi_app = ProxyFix(app.wsgi_app)
+
+    @app.cli.command()
+    @click.argument('command')
+    def setup(command):
+        pass
+
+    return app
+

app/config.py

@@ -0,0 +1,34 @@
+import os
+
+
+class Config:
+    ERROR_404_HELP = False
+
+    SECRET_KEY = os.getenv('APP_SECRET', 'secret key')
+
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///tutorial.db'
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+
+    DOC_USERNAME = 'api'
+    DOC_PASSWORD = 'password'
+
+
+class DevConfig(Config):
+    DEBUG = True
+
+
+class TestConfig(Config):
+    SQLALCHEMY_DATABASE_URI = 'sqlite://'
+    TESTING = True
+    DEBUG = True
+
+
+class ProdConfig(Config):
+    DEBUG = False
+
+
+config = {
+    'development': DevConfig,
+    'testing': TestConfig,
+    'production': ProdConfig
+}

app/factory.py

@@ -0,0 +1,48 @@
+import logging
+import os
+import sys
+from logging.handlers import RotatingFileHandler
+
+from flask import Flask
+
+from .config import config
+
+
+class Factory:
+
+    def __init__(self, environment='development'):
+        self._environment = os.environ.get('APP_ENVIRONMENT', environment)
+        self.flask = None
+
+    @property
+    def environment(self):
+        return self._environment
+
+    @environment.setter
+    def environment(self, env):
+        self._environment = env
+
+    def set_flask(self, **kwargs):
+        self.flask = Flask(__name__, **kwargs)
+        self.flask.config.from_object(config[self._environment])
+        # setup logging
+        file_handler = RotatingFileHandler('api.log', maxBytes=10000, backupCount=1)
+        file_handler.setLevel(logging.INFO)
+        self.flask.logger.addHandler(file_handler)
+        stdout = logging.StreamHandler(sys.stdout)
+        stdout.setLevel(logging.DEBUG)
+        self.flask.logger.addHandler(stdout)
+
+        return self.flask
+
+    def set_db(self):
+        from .models.database import db
+        db.init_app(self.flask)
+
+    def set_migration(self):
+        from .models.database import db, migrate
+        migrate.init_app(self.flask, db)
+
+    def set_api(self):
+        from .resources import api
+        api.init_app(self.flask, version='1.0.0', title='api')

app/models/__init__.py

@@ -0,0 +1 @@
+from .base import Example

app/models/base.py

@@ -0,0 +1,15 @@
+from sqlalchemy import Column, DateTime, func, Integer, String
+
+from .database import db
+
+
+class Base(db.Model):
+    __abstract__ = True
+
+    id = Column(Integer, primary_key=True)
+    created_at = Column(DateTime, default=func.now())
+    updated_at = Column(DateTime, onupdate=func.now())
+
+
+class Example(Base):
+    name = Column(String)

app/models/database.py

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

app/models/datastore.py

@@ -0,0 +1,22 @@
+from abc import ABC
+
+from .base import Example
+
+
+class Datastore(ABC):
+
+    def __init__(self, _db=None):
+        self.session = None
+        if _db:
+            self.session = _db.session
+
+
+class ExampleDatastore(Datastore):
+
+    def __init__(self, _db):
+        super().__init__(_db)
+
+    def create_example(self, name):
+        ex = Example(name=name)
+        self.session.add(ex)
+        self.session.commit()

app/resources/__init__.py

@@ -0,0 +1,6 @@
+from .example import ns as example_ns
+from ..utils import PatchedApi
+
+api = PatchedApi()
+
+api.add_namespace(example_ns)