Initial Commit

Author: BisratYalew

.gitignore

@@ -0,0 +1,66 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# PyCharm
+.idea/
+env/*
+env
+migrations
+migrations/*
+
+# OSX
+.DS_Store

README.md

@@ -0,0 +1,32 @@
+# Flask Rest API
+This program shows how to set up a flaskrestapi with postgres_db, blueprint, sqlalchemy, marshmallow, wsgi, unittests
+
+# Install guide
+
+### Clone the repo
+
+```$ git clone https://github.com/bisratyalew/flask-rest-api.git```
+```$ cd flask-api-example```
+
+### Create the virtualenv
+
+```$ mkvirtualenv flask-api-example```
+
+### Install dependencies
+
+```$ pip install -r requirements.txt```
+
+### Running on development machine
+```
+python manage.py runserver
+```
+
+### Features
+
+* Rest Api Flask App
+* Serialize object into response
+* Integration with Flask-IO to parse parameters from request
+* Configuration per environment
+* Integration with SQL Alchemy
+* Uses Postgres DB
+* Unit tests per module

flast_rest_app/__init__.py

@@ -0,0 +1,5 @@
+from flask_io import FlaskIO
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()
+io = FlaskIO()

flast_rest_app/application.py

@@ -0,0 +1,50 @@
+import logging
+import os
+
+from flask import Flask
+from werkzeug.utils import import_string
+from . import config, db, io
+
+logger = logging.getLogger(__name__)
+
+
+def create_app(environment):
+    """Creates a new Flask application and initialize application."""
+
+    config_map = {
+        'development': config.Development(),
+        'testing': config.Testing(),
+        'production': config.Production(),
+    }
+
+    config_obj = config_map[environment.lower()]
+
+    app = Flask(__name__)
+    app.config.from_object(config_obj)
+    app.url_map.strict_slashes = False
+    app.add_url_rule('/', 'home', home)
+
+    register_blueprints(app)
+
+    db.init_app(app)
+    io.init_app(app)
+
+    return app
+
+
+def home():
+    return dict(name='Flask REST API')
+
+
+def register_blueprints(app):
+    root_folder = 'flask_rest_api'
+
+    for dir_name in os.listdir(root_folder):
+        module_name = root_folder + '.' + dir_name + '.views'
+        module_path = os.path.join(root_folder, dir_name, 'views.py')
+
+        if os.path.exists(module_path):
+            module = import_string(module_name)
+            obj = getattr(module, 'app', None)
+            if obj:
+                app.register_blueprint(obj)

flast_rest_app/companies/__init__.py

@@ -0,0 +1 @@
+##

flast_rest_app/companies/models.py

@@ -0,0 +1,14 @@
+from datetime import datetime
+from .. import db
+
+
+class Company(db.Model):
+    __tablename__ = 'table_companies'
+
+    id = db.Column(db.Integer(), primary_key=True, autoincrement=True)
+    name = db.Column(db.String(20), nullable=False)
+    country_code = db.Column(db.String(2), nullable=False)
+    website = db.Column(db.String(100))
+    enabled = db.Column(db.Boolean(), nullable=False, default=True)
+    updated_at = db.Column(db.DateTime(), nullable=False, default=lambda: datetime.utcnow())
+    created_at = db.Column(db.DateTime(), nullable=False, default=lambda: datetime.utcnow())

flast_rest_app/companies/schemas.py

@@ -0,0 +1,16 @@
+from flask_io import fields, Schema, post_dump
+from .models import Company
+
+
+class CompanySchema(Schema):
+    id = fields.Integer(dump_only=True)
+    name = fields.String(required=True)
+    country_code = fields.String(required=True)
+    website = fields.String(allow_none=True)
+    enabled = fields.Boolean(required=True)
+    updated_at = fields.DateTime(dump_only=True)
+    created_at = fields.DateTime(dump_only=True)
+
+    @post_dump
+    def make_object(self, data):
+        return Company(**data)

flast_rest_app/companies/views.py

@@ -0,0 +1,81 @@
+from datetime import datetime
+from flask import Blueprint
+from flask_io import fields
+from sqlalchemy import func
+from sqlalchemy_utils.functions import sort_query
+from .models import Company
+from .schemas import CompanySchema
+from .. import db, io
+
+app = Blueprint('companies', __name__, url_prefix='/companies')
+  
+
+@app.route('/', methods=['POST'])
+@io.from_body('company', CompanySchema)
+def add_company(company):
+    db.session.add(company)
+    db.session.commit()
+    return company
+
+
+@app.route('/<int:id>', methods=['DELETE'])
+def delete_company(id):
+    company = Company.query.filter_by(id=id).first()
+
+    if not company:
+        return io.not_found('Company not found: ' + str(id))
+
+    db.session.delete(company)
+    db.session.commit()
+
+    return io.no_content()
+
+
+@app.route('/<int:id>', methods=['GET'])
+@io.marshal_with(CompanySchema)
+def get_company(id):
+    company = Company.query.filter_by(id=id).first()
+
+    if not company:
+        return io.not_found('Company not found: ' + str(id))
+
+    return company
+
+
+@app.route('/', methods=['GET'])
+@io.from_query('name', fields.String())
+@io.from_query('order_by', fields.String(missing='name'))
+@io.from_query('offset', fields.Integer(missing=0))
+@io.from_query('limit', fields.Integer(missing=10))
+@io.marshal_with(CompanySchema)
+def list_companies(name, order_by, offset, limit):
+    query = Company.query
+
+    if name:
+        query = query.filter(func.lower(Company.name).contains(func.lower(name)))
+    if order_by:
+        query = sort_query(query, order_by)
+    if offset:
+        query = query.offset(offset)
+    if limit:
+        query = query.limit(limit)
+
+    return query.all()
+
+
+@app.route('/<int:id>', methods=['POST', 'PATCH'])
+@io.from_body('update_company', CompanySchema)
+@io.marshal_with(CompanySchema)
+def update_company(id, new_company):
+    company = Company.query.filter_by(id=id).first()
+
+    if not company:
+        return io.not_found('Company not found: ' + str(id))
+
+    company.name = new_company.name
+    company.country_code = new_company.country_code
+    company.website = new_company.website
+    company.enabled = new_company.enabled
+    company.updated_at = datetime.now()
+
+    return company

flast_rest_app/config.py

@@ -0,0 +1,19 @@
+class Development(object):
+    DEBUG = True
+
+    ## DB URL FOR DEVELOPMENT
+    SQLALCHEMY_DATABASE_URI = 'postgres://user:pass@localhost/dbname'
+
+
+class Testing(object):
+    DEBUG = False
+    
+    ## DB URL FOR TESTING
+    SQLALCHEMY_DATABASE_URI = 'postgres://user:pass@test/dbname'
+
+
+class Production(object):
+    DEBUG = False
+
+    ## DB URL FOR PRODUCTION
+    SQLALCHEMY_DATABASE_URI = 'postgres://user:pass@production/dbname'

manage.py

@@ -0,0 +1,14 @@
+from flask_migrate import Migrate, MigrateCommand
+from flask_script import Manager
+from flask_rest_api import db
+from flask_rest_api.application import create_app
+
+app = create_app('development')
+
+migrate = Migrate(app, db)
+
+manager = Manager(app)
+manager.add_command('db', MigrateCommand)
+
+if __name__ == "__main__":
+    manager.run()

requirements.txt

@@ -0,0 +1,8 @@
+## Requirements to install
+flask==0.10.1
+flask-io==1.10.0
+flask-migrate==1.7.0
+flask-script==2.0.5
+flask-sqlalchemy==2.1
+sqlalchemy-utils==0.31.6
+psycopg2==2.6.1

tests/__init__.py

@@ -0,0 +1 @@
+##

tests/company_test.py

@@ -0,0 +1,55 @@
+import json
+
+from flask_rest_api import db
+from flask_rest_api.application import create_app
+
+## Module to make a unit test
+from unittest import TestCase
+
+
+class TestView(TestCase):
+    def setUp(self):
+        self.app = create_app('development')
+        self.client = self.app.test_client()
+        db.create_all(app=self.app)
+
+    def test_create_company(self):
+        data = dict(name='test', country_code='ET', website='http://example.com', enabled=True)
+        response = self.client.post('/companies', data=json.dumps(data), content_type='application/json')
+        assert response.status_code == 200
+
+    def test_delete_company(self):
+        data = dict(name='test', country_code='ET', website='http://example.com', enabled=True)
+        response = self.client.post('/companies', data=json.dumps(data), content_type='application/json')
+
+        company = json.loads(response.get_data(as_text=True))
+
+        response = self.client.delete('/companies/' + str(company.get('id')))
+        assert response.status_code == 204
+
+
+    def get_company(self):
+        data = dict(name='test', country_code='ET', website='http://example.com', enabled=True)
+        response = self.client.post('/companies', data=json.dumps(data), content_type='application/json')
+        company = json.loads(response.get_data(as_text=True))
+
+        response = self.client.get('/companies/' + str(company.get('id')))
+
+        assert response.status_code == 200
+
+        company = json.loads(response.get_data(as_text=True))
+
+        assert company.get('name') == 'test'
+
+ 
+    def list_companies(self):
+        data = dict(name='test', country_code='ET', website='http://example.com', enabled=True)
+        self.client.post('/companies', data=json.dumps(data), content_type='application/json')
+
+        response = self.client.get('/companies')
+
+        assert response.status_code == 200
+
+        companies = json.loads(response.get_data(as_text=True))
+
+        assert len(companies) == 1

wsgi.py

@@ -0,0 +1,11 @@
+import os
+
+from flask_rest_app.application import create_app
+
+
+env = os.environ.get('APP_ENV')
+
+if not env:
+    raise Exception('APP_ENV can not be found')
+
+application = create_app(env)