Added Flask-Cache for Mostly Static Endpoints

dataserv/app.py

@@ -8,7 +8,8 @@
 from flask import make_response, jsonify, request
 
 from sqlalchemy import desc
-from dataserv.run import app, db
+from dataserv.run import app, db, cache
+
 from dataserv.config import logging
 from dataserv.Farmer import Farmer, AuthError
 
@@ -42,6 +43,10 @@ def online_farmers():
     return q.all()
 
 
+def disable_caching():
+    return app.config["DISABLE_CACHING"]
+
+
 # Routes
 @app.route('/')
 def index():
@@ -109,6 +114,7 @@ def get_address():
 
 
 @app.route('/api/online', methods=["GET"])
+@cache.cached(timeout=app.config["CACHING_TIME"], unless=disable_caching)
 def online():
     """Display a readable list of online farmers."""
     logger.info("CALLED /api/online")
@@ -124,6 +130,7 @@ def online():
 
 
 @app.route('/api/online/json', methods=["GET"])
+@cache.cached(timeout=app.config["CACHING_TIME"], unless=disable_caching)
 def online_json():
     """Display a machine readable list of online farmers."""
     logger.info("CALLED /api/online/json")
@@ -138,6 +145,7 @@ def online_json():
 
 
 @app.route('/api/total', methods=["GET"])
+@cache.cached(timeout=app.config["CACHING_TIME"], unless=disable_caching)
 def total():
     logger.info("CALLED /api/total")
 

dataserv/config.py

@@ -16,3 +16,6 @@
 logging.basicConfig(format=_log_format, filename='dataserv.log',
                     level=logging.DEBUG)
 TOTAL_UPDATE = 30  # minutes
+
+DISABLE_CACHING = False
+CACHING_TIME = 30  # seconds

dataserv/run.py

@@ -1,8 +1,11 @@
 from flask import Flask
+from flask.ext.cache import Cache
 from flask.ext.sqlalchemy import SQLAlchemy
 
-
 # Initialize the Flask application
+cache = Cache(config={'CACHE_TYPE': 'simple'})
+
 app = Flask(__name__)
 app.config.from_pyfile('config.py')
 db = SQLAlchemy(app)
+cache.init_app(app)

requirements.txt

@@ -3,3 +3,4 @@ Flask-SQLAlchemy == 2.0
 RandomIO == 0.2.1
 partialhash == 1.1.0
 btctxstore == 4.5.0
+Flask-Cache == 0.13.1

tests/test_App.py

@@ -15,6 +15,7 @@
 class TemplateTest(unittest.TestCase):
     def setUp(self):
         app.config["SKIP_AUTHENTICATION"] = True  # monkey patch
+        app.config["DISABLE_CACHING"] = True
 
         self.app = app.test_client()
         db.create_all()
@@ -305,7 +306,6 @@ def test_farmer_total_bytes(self):
 
         # check online
         rv = self.app.get('/api/online')
-
         self.assertTrue(b"0" in rv.data)
         self.assertTrue(b"2475" in rv.data)
         self.assertTrue(b"2525" in rv.data)

tests/test_Farmer.py

@@ -20,6 +20,8 @@ class FarmerTest(unittest.TestCase):
 
     def setUp(self):
         app.config["SKIP_AUTHENTICATION"] = True  # monkey patch
+        app.config["DISABLE_CACHING"] = True
+
         db.create_all()
 
     def tearDown(self):