You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
60 lines
1.8 KiB
60 lines
1.8 KiB
#!/usr/bin/env python |
|
# -*- encoding: utf-8 -*- |
|
|
|
"""Helper functions.""" |
|
|
|
from functools import wraps |
|
|
|
from flask import request |
|
from flask import jsonify |
|
|
|
|
|
class ForceJSON(object): |
|
def __init__(self, required=None): |
|
self.required = required or [] |
|
|
|
def __call__(self, func): |
|
@wraps(func) |
|
def check_json(*args, **kwargs): |
|
json = request.get_json(force=True, silent=True) |
|
if not json: |
|
resp = jsonify(status='ERROR', |
|
error='Request MUST be in JSON format') |
|
resp.status_code = 400 |
|
return resp |
|
|
|
# now we have the JSON, let's check if all the fields are here. |
|
missing = [] |
|
for field in self.required or []: |
|
if not field in json: |
|
missing.append(field) |
|
|
|
if missing: |
|
fields = ', '.join(missing) |
|
error = 'Missing fields: {fields}'.format(fields=fields) |
|
resp = jsonify(status='ERROR', |
|
error=error) |
|
resp.status_code = 400 |
|
return resp |
|
|
|
return func(*args, **kwargs) |
|
return check_json |
|
|
|
|
|
def JSONError(status, message, **kwargs): |
|
"""Generate a JSON error message with the error and extra fields. |
|
|
|
:param status: the HTTP status code for the error |
|
:type status: int |
|
:param message: The message in the error |
|
:type message: str |
|
:param kwargs: Extra fields to be added in the response. *Note*: `status` |
|
and `message` should **NOT** be used. |
|
:type kwargs: kwargs |
|
|
|
:return: A response with the JSON and the status code.""" |
|
resp = jsonify(status='ERROR', |
|
error=message, |
|
**kwargs) |
|
resp.status_code = status |
|
return resp
|
|
|