Initial commit.

Dockerfile

@@ -0,0 +1,11 @@
+FROM debian:buster
+MAINTAINER yohan <783b8c87@scimetis.net>
+ENV DEBIAN_FRONTEND noninteractive
+ENV TZ Europe/Paris
+RUN apt-get update && apt-get -y install python-pip python-mysqldb python-yaml
+RUN pip install flask-restx flask-sqlalchemy flask-migrate
+WORKDIR /root
+COPY api.py /root/
+COPY migrate_db.sh /root/
+COPY entrypoint.sh /root/
+ENTRYPOINT ["/root/entrypoint.sh"]

api.py

@@ -0,0 +1,133 @@
+from flask import Flask, request
+from flask_restx import Api, Resource, fields
+from functools import wraps
+from flask_sqlalchemy import SQLAlchemy
+from flask_migrate import Migrate
+import json
+import logging
+import yaml
+import os
+import sys
+
+logging.basicConfig(level=logging.WARNING)
+
+authorizations = {
+    'apikey': {
+        'type': 'apiKey',
+        'in': 'header',
+        'name': 'X-API-KEY'
+    }
+}
+
+with open('./conf.yml') as conf:
+    yaml_conf = yaml.load(conf)
+    flask_settings = yaml_conf.get("flask_settings")
+    api_key = yaml_conf.get("api_key")
+    if os.environ['FLASK_ENV'] == 'development':
+        flask_settings_env = yaml_conf.get("flask_settings_dev")
+        logging.getLogger().setLevel(logging.DEBUG)
+    elif os.environ['FLASK_ENV'] == 'production':
+        flask_settings_env = yaml_conf.get("flask_settings_prod")
+        logging.getLogger().setLevel(logging.WARNING)
+    else:
+        logging.error("FLASK_ENV must be set to development or production.")
+        sys.exit(1)
+
+def auth_required(func):
+    func = api.doc(security='apikey')(func)
+    @wraps(func)
+    def check_auth(*args, **kwargs):
+        if 'X-API-KEY' not in request.headers:
+            api.abort(401, 'API key required')
+        key = request.headers['X-API-KEY']
+        # Check key validity
+        if key != api_key:
+            api.abort(401, 'Wrong API key')
+        return func(*args, **kwargs)
+    return check_auth
+
+app = Flask(__name__)
+app.config.from_mapping(flask_settings)
+app.config.from_mapping(flask_settings_env)
+db = SQLAlchemy(app)
+api = Api(app, version='1.0', title='Stock recording',
+    description='API to record and access stock market values.', authorizations=authorizations)
+
+ns = api.namespace('/', description='Stock API')
+
+class Stock(db.Model):
+    __tablename__ = "Stock"
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
+    time = db.Column(db.DateTime, nullable=False)
+    price = db.Column(db.Float, nullable=False)
+    volume = db.Column(db.Integer, nullable=False)
+    metric = db.Column(db.String(10), index=True, nullable=False)
+
+model = api.model('Model', {
+    'time': fields.DateTime(dt_format='iso8601'),
+    'price': fields.Float(required=True, description='price'),
+    'volume': fields.Integer(required=True, description='volume'),
+    'metric': fields.String(required=True, description='Stock name'),
+})
+
+resource_fields = {
+    'time': fields.DateTime(dt_format='iso8601'),
+    'price': fields.Float(required=True, description='price'),
+    'volume': fields.Integer(required=True, description='volume'),
+    'metric': fields.String(required=True, description='Stock name'),
+}
+fields_pagination = {
+    'current_page': fields.Integer(description='current page number'),
+    'pages': fields.Integer(description='pages count'),
+    'total_results': fields.Integer(description='results count'),
+    'datas': fields.Nested(api.model('Model_resource', resource_fields))
+}
+model_pagination = api.model('Model_pagination', fields_pagination)
+
+@ns.route('/add')
+class Global_stocks(Resource):
+    @auth_required 
+    @api.expect(model, validate=True)
+    def post(self):
+        try:
+            data = Stock(**request.json)
+            db.session.add(data)
+            db.session.commit()
+            return "OK", 201
+        except Exception as e:
+            logging.error(e)
+            return "K0", 400
+
+@ns.route('/search')
+class Search_stocks(Resource):
+    @auth_required
+    @api.marshal_with(model_pagination, envelope='resource')
+    def get(self):
+        logging.debug(json.loads(request.args.get("filter")))
+        page = request.args.get('page', default = 1, type = int)
+        filters = json.loads(request.args.get("filter", default = '*', type = str))
+        record_query = Stock.query.filter()
+        for stock_filter in filters:
+            if 'name' in stock_filter.keys():
+                if stock_filter['name'] == 'metric':
+                    record_query = record_query.filter(Stock.metric == stock_filter["val"])
+                if stock_filter['name'] in ['price', 'volume', 'time']:
+                    if stock_filter['op'] == 'le':
+                        record_query = record_query.filter(getattr(Stock, stock_filter['name']) <= stock_filter["val"])
+                    if stock_filter['op'] == 'ge':
+                        record_query = record_query.filter(getattr(Stock, stock_filter['name']) >= stock_filter["val"])
+                    if stock_filter['op'] == 'eq':
+                        record_query = record_query.filter(getattr(Stock, stock_filter['name']) == stock_filter["val"])
+                
+        record_query = record_query.paginate(page=page, per_page=20)
+        result = dict(datas=record_query.items, 
+                   total_results=record_query.total, 
+                   current_page=record_query.page,
+                   pages=record_query.pages)
+        logging.debug(result)
+        return result
+
+api.add_namespace(ns)
+db.create_all()
+migrate = Migrate(app, db, compare_type=True)
+

conf.yml-example

@@ -0,0 +1,12 @@
+flask_settings:
+  SQLALCHEMY_DATABASE_URI: 'mysql://stock-recording:FIXME@mysql-server/stock_recording'
+
+api_key: "FIXME"
+
+flask_settings_dev:
+  DEBUG: True
+  SQLALCHEMY_TRACK_MODIFICATIONS: False
+
+flask_settings_prod:
+  DEBUG: False
+  SQLALCHEMY_TRACK_MODIFICATIONS: True

entrypoint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+/root/migrate_db.sh && exec flask run

migrate_db.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+flask db init; flask db migrate -m "Database migration." && flask db upgrade