Fixes #23 Add support for configs and flex databases

Author: EliuX

tests/projects/projects_namespace_test.py

@@ -8,4 +8,4 @@ def test_list_should_return_nothing(client):
     assert 200 == response.status_code
 
     json_data = json.loads(response.data)
-    assert [] == json_data
+    assert [] == json_data

tests/time_entries/__init__.py

@@ -0,0 +1,10 @@
+from flask import json
+
+def test_list_should_return_empty_array(client):
+    """Should return an empty array"""
+    response = client.get("/time-entries", follow_redirects=True)
+
+    assert 200 == response.status_code
+
+    json_data = json.loads(response.data)
+    assert [] == json_data

tests/time_entries/time_enties_namespace_test.py

@@ -1,14 +1,37 @@
+import os
 from flask import Flask
 
 
-def create_app():
+def create_app(config_path='time_tracker_api.config.WhateverDevelopConfig',
+               config_data=None):
     flask_app = Flask(__name__)
 
+    init_app_config(flask_app, config_path, config_data)
     init_app(flask_app)
 
     return flask_app
 
 
+def init_app_config(app, config_path, config_data=None):
+    if config_path:
+        app.config.from_object(config_path)
+    else:
+        # ensure the instance folder exists
+        try:
+            os.makedirs(app.instance_path)
+        except OSError:
+            pass
+
+        # Located in `/instance`
+        app.config.from_pyfile('config.py', silent=True)
+
+    if config_data:
+        app.config.update(config_data)
+
+
 def init_app(app: Flask):
+    from .database import init_app as init_database
+    init_database(app)
+
     from .api import api
     api.init_app(app)

time_tracker_api/__init__.py

@@ -0,0 +1,9 @@
+class Config:
+    DEBUG = False
+
+
+class WhateverDevelopConfig(Config):
+    DEBUG = True
+    FLASK_DEBUG = True
+    FLASK_ENV = "develop"
+    DATABASE = "whatever"

time_tracker_api/config.py

@@ -0,0 +1,28 @@
+"""
+Agnostic database assets
+
+Put here your utils and class independent of
+the database solution
+"""
+from flask import Flask
+
+RepositoryModel = None
+
+
+def init_app(app: Flask) -> None:
+    """Make the app ready to use the database"""
+    database_strategy_name = app.config['DATABASE']
+    with app.app_context():
+        module = globals()["use_%s" % database_strategy_name]()
+        global RepositoryModel
+        RepositoryModel = module.repository_model
+
+
+def create(model_name: str):
+    """Creates the repository instance for the chosen database"""
+    return RepositoryModel(model_name)
+
+
+def use_whatever():
+    from time_tracker_api import whatever_repository
+    return whatever_repository

time_tracker_api/database.py

@@ -1,5 +1,6 @@
 from flask_restplus import fields, Resource, Namespace
 from time_tracker_api.api import audit_fields
+from time_tracker_api import database
 
 ns = Namespace('time-entries', description='API for time entries')
 
@@ -61,13 +62,15 @@
 )
 
 
+model = database.create('time-entries')
+
 @ns.route('')
 class TimeEntries(Resource):
     @ns.doc('list_time_entries')
     @ns.marshal_list_with(time_entry_response, code=200)
     def get(self):
         """List all available time entries"""
-        return []
+        return model.find_all()
 
     @ns.doc('create_time_entry')
     @ns.expect(time_entry)

time_tracker_api/time_entries/time_entries_namespace.py

@@ -0,0 +1,10 @@
+class WhateverRepository():
+    def __init__(self, model_name):
+        self.model_name = model_name
+
+    def find_all(self):
+        print('Fetching all entries from {0}'.format(self.model_name))
+        return []
+
+
+repository_model = WhateverRepository