mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-21 07:51:13 -05:00
b5c662eca8
Ideally all the primary keys in the db would be UUID in order to guarantee unique ids across distributed dbs. This updates the services.id to a UUID. All the tables with a foreign key to the services.id are also updated. The endpoints no longer state a data type of the <service_id> path param. All the tests are updated to reflect this update. The thing to pay attention to is the 0011_uuid_service_id.py migration script. This commit must go with a commit on the notifications_admin app to keep things working. There will be a small outage until both deploys have happened.
195 lines
7.6 KiB
Python
195 lines
7.6 KiB
Python
from datetime import datetime
|
|
|
|
from flask import (jsonify, request)
|
|
from sqlalchemy.exc import DataError
|
|
from sqlalchemy.orm.exc import NoResultFound
|
|
|
|
from app import db
|
|
from app.dao import DAOException
|
|
from app.dao.services_dao import (
|
|
save_model_service, get_model_services, delete_model_service)
|
|
from app.dao.templates_dao import (
|
|
save_model_template, get_model_templates, delete_model_template)
|
|
from app.dao.api_key_dao import (save_model_api_key, get_model_api_keys, get_unsigned_secret)
|
|
from app.models import ApiKey
|
|
from app.schemas import (
|
|
services_schema, service_schema, template_schema, templates_schema,
|
|
api_keys_schema, service_schema_load_json, template_schema_load_json)
|
|
|
|
from flask import Blueprint
|
|
service = Blueprint('service', __name__)
|
|
|
|
|
|
@service.route('', methods=['POST'])
|
|
def create_service():
|
|
# TODO what exceptions get passed from schema parsing?
|
|
service, errors = service_schema.load(request.get_json())
|
|
if errors:
|
|
return jsonify(result="error", message=errors), 400
|
|
# I believe service is already added to the session but just needs a
|
|
# db.session.commit
|
|
try:
|
|
save_model_service(service)
|
|
except DAOException as e:
|
|
return jsonify(result="error", message=str(e)), 400
|
|
return jsonify(data=service_schema.dump(service).data), 201
|
|
|
|
|
|
@service.route('/<service_id>', methods=['PUT', 'DELETE'])
|
|
def update_service(service_id):
|
|
try:
|
|
service = get_model_services(service_id=service_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid service id"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Service not found"), 404
|
|
if request.method == 'DELETE':
|
|
status_code = 202
|
|
delete_model_service(service)
|
|
else:
|
|
status_code = 200
|
|
update_dict, errors = service_schema_load_json.load(request.get_json())
|
|
if errors:
|
|
return jsonify(result="error", message=errors), 400
|
|
try:
|
|
save_model_service(service, update_dict=update_dict)
|
|
except DAOException as e:
|
|
return jsonify(result="error", message=str(e)), 400
|
|
return jsonify(data=service_schema.dump(service).data), status_code
|
|
|
|
|
|
@service.route('/<service_id>', methods=['GET'])
|
|
@service.route('', methods=['GET'])
|
|
def get_service(service_id=None):
|
|
user_id = request.args.get('user_id', None)
|
|
try:
|
|
services = get_model_services(service_id=service_id, user_id=user_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid service id"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Service not found"), 404
|
|
data, errors = services_schema.dump(services) if isinstance(services, list) else service_schema.dump(services)
|
|
return jsonify(data=data)
|
|
|
|
|
|
@service.route('/<service_id>/api-key', methods=['POST'])
|
|
def renew_api_key(service_id=None):
|
|
try:
|
|
service = get_model_services(service_id=service_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid service id"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Service not found"), 404
|
|
|
|
try:
|
|
# create a new one
|
|
# TODO: what validation should be done here?
|
|
secret_name = request.get_json()['name']
|
|
key = ApiKey(service=service, name=secret_name)
|
|
save_model_api_key(key)
|
|
except DAOException as e:
|
|
return jsonify(result='error', message=str(e)), 400
|
|
unsigned_api_key = get_unsigned_secret(key.id)
|
|
return jsonify(data=unsigned_api_key), 201
|
|
|
|
|
|
@service.route('/<service_id>/api-key/revoke/<int:api_key_id>', methods=['POST'])
|
|
def revoke_api_key(service_id, api_key_id):
|
|
try:
|
|
service_api_key = get_model_api_keys(service_id=service_id, id=api_key_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid api key for service"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Api key not found for service"), 404
|
|
|
|
save_model_api_key(service_api_key, update_dict={'id': service_api_key.id, 'expiry_date': datetime.utcnow()})
|
|
return jsonify(), 202
|
|
|
|
|
|
@service.route('/<service_id>/api-keys', methods=['GET'])
|
|
@service.route('/<service_id>/api-keys/<int:key_id>', methods=['GET'])
|
|
def get_api_keys(service_id, key_id=None):
|
|
try:
|
|
service = get_model_services(service_id=service_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid service id"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Service not found"), 404
|
|
|
|
try:
|
|
if key_id:
|
|
api_keys = [get_model_api_keys(service_id=service_id, id=key_id)]
|
|
else:
|
|
api_keys = get_model_api_keys(service_id=service_id)
|
|
except DAOException as e:
|
|
return jsonify(result='error', message=str(e)), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="API key not found"), 404
|
|
|
|
return jsonify(apiKeys=api_keys_schema.dump(api_keys).data), 200
|
|
|
|
|
|
@service.route('/<service_id>/template', methods=['POST'])
|
|
def create_template(service_id):
|
|
try:
|
|
service = get_model_services(service_id=service_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid service id"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Service not found"), 404
|
|
template, errors = template_schema.load(request.get_json())
|
|
if errors:
|
|
return jsonify(result="error", message=errors), 400
|
|
template.service = service
|
|
# I believe service is already added to the session but just needs a
|
|
# db.session.commit
|
|
save_model_template(template)
|
|
return jsonify(data=template_schema.dump(template).data), 201
|
|
|
|
|
|
@service.route('/<service_id>/template/<int:template_id>', methods=['PUT', 'DELETE'])
|
|
def update_template(service_id, template_id):
|
|
try:
|
|
service = get_model_services(service_id=service_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid service id"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Service not found"), 404
|
|
try:
|
|
template = get_model_templates(template_id=template_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid template id"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Template not found"), 404
|
|
if request.method == 'DELETE':
|
|
status_code = 202
|
|
delete_model_template(template)
|
|
else:
|
|
status_code = 200
|
|
update_dict, errors = template_schema_load_json.load(request.get_json())
|
|
if errors:
|
|
return jsonify(result="error", message=errors), 400
|
|
try:
|
|
save_model_template(template, update_dict=update_dict)
|
|
except DAOException as e:
|
|
return jsonify(result="error", message=str(e)), 400
|
|
return jsonify(data=template_schema.dump(template).data), status_code
|
|
|
|
|
|
@service.route('/<service_id>/template/<int:template_id>', methods=['GET'])
|
|
@service.route('/<service_id>/template', methods=['GET'])
|
|
def get_service_template(service_id, template_id=None):
|
|
try:
|
|
templates = get_model_templates(service_id=service_id, template_id=template_id)
|
|
except DataError:
|
|
return jsonify(result="error", message="Invalid template id"), 400
|
|
except NoResultFound:
|
|
return jsonify(result="error", message="Template not found"), 404
|
|
if isinstance(templates, list):
|
|
data, errors = templates_schema.dump(templates)
|
|
else:
|
|
data, errors = template_schema.dump(templates)
|
|
if errors:
|
|
return jsonify(result="error", message=str(errors))
|
|
return jsonify(data=data)
|