Files
notifications-api/app/organization/rest.py

243 lines
8.5 KiB
Python
Raw Normal View History

2021-03-10 13:55:06 +00:00
from flask import Blueprint, abort, current_app, jsonify, request
2023-07-11 10:58:58 -07:00
from sqlalchemy.exc import IntegrityError
from app.config import QueueNames
from app.dao.annual_billing_dao import set_default_free_allowance_for_service
from app.dao.dao_utils import transaction
2023-07-10 11:06:29 -07:00
from app.dao.fact_billing_dao import fetch_usage_year_for_organization
from app.dao.organization_dao import (
dao_add_service_to_organization,
dao_add_user_to_organization,
dao_create_organization,
dao_get_organization_by_email_address,
dao_get_organization_by_id,
dao_get_organization_services,
dao_get_organizations,
dao_get_users_for_organization,
dao_remove_user_from_organization,
dao_update_organization,
)
2018-02-10 01:37:17 +00:00
from app.dao.services_dao import dao_fetch_service_by_id
2021-03-10 13:55:06 +00:00
from app.dao.templates_dao import dao_get_template_by_id
from app.dao.users_dao import get_user_by_id
2021-03-10 13:55:06 +00:00
from app.errors import InvalidRequest, register_errors
2023-07-10 11:06:29 -07:00
from app.models import KEY_TYPE_NORMAL, Organization
2021-03-10 13:55:06 +00:00
from app.notifications.process_notifications import (
persist_notification,
send_notification_to_queue,
)
2023-07-10 11:06:29 -07:00
from app.organization.organization_schema import (
post_create_organization_schema,
post_link_service_to_organization_schema,
post_update_organization_schema,
)
from app.schema_validation import validate
2023-08-29 14:54:30 -07:00
organization_blueprint = Blueprint("organization", __name__)
2023-07-10 11:06:29 -07:00
register_errors(organization_blueprint)
2023-07-10 11:06:29 -07:00
@organization_blueprint.errorhandler(IntegrityError)
def handle_integrity_error(exc):
"""
2023-07-10 11:06:29 -07:00
Handle integrity errors caused by the unique constraint on ix_organization_name
"""
2023-07-11 10:58:58 -07:00
print(exc)
current_app.logger.exception(exc)
2023-08-29 14:54:30 -07:00
if "ix_organization_name" in str(exc):
return jsonify(result="error", message="Organization name already exists"), 400
if 'duplicate key value violates unique constraint "domain_pkey"' in str(exc):
2023-08-29 14:54:30 -07:00
return jsonify(result="error", message="Domain already exists"), 400
2023-08-29 14:54:30 -07:00
return jsonify(result="error", message="Internal server error"), 500
2023-08-29 14:54:30 -07:00
@organization_blueprint.route("", methods=["GET"])
2023-07-10 11:06:29 -07:00
def get_organizations():
2023-08-29 14:54:30 -07:00
organizations = [org.serialize_for_list() for org in dao_get_organizations()]
2023-07-10 11:06:29 -07:00
return jsonify(organizations)
2023-08-29 14:54:30 -07:00
@organization_blueprint.route("/<uuid:organization_id>", methods=["GET"])
2023-07-10 11:06:29 -07:00
def get_organization_by_id(organization_id):
organization = dao_get_organization_by_id(organization_id)
return jsonify(organization.serialize())
2023-08-29 14:54:30 -07:00
@organization_blueprint.route("/by-domain", methods=["GET"])
2023-07-10 11:06:29 -07:00
def get_organization_by_domain():
2023-08-29 14:54:30 -07:00
domain = request.args.get("domain")
2023-08-29 14:54:30 -07:00
if not domain or "@" in domain:
abort(400)
2023-07-10 11:06:29 -07:00
organization = dao_get_organization_by_email_address(
2023-08-29 14:54:30 -07:00
"example@{}".format(request.args.get("domain"))
)
2023-07-10 11:06:29 -07:00
if not organization:
abort(404)
2023-07-10 11:06:29 -07:00
return jsonify(organization.serialize())
2023-08-29 14:54:30 -07:00
@organization_blueprint.route("", methods=["POST"])
2023-07-10 11:06:29 -07:00
def create_organization():
data = request.get_json()
2023-07-10 11:06:29 -07:00
validate(data, post_create_organization_schema)
organization = Organization(**data)
2023-07-11 10:58:58 -07:00
dao_create_organization(organization)
2023-07-10 14:21:36 -07:00
2023-07-10 11:06:29 -07:00
return jsonify(organization.serialize()), 201
2023-08-29 14:54:30 -07:00
@organization_blueprint.route("/<uuid:organization_id>", methods=["POST"])
2023-07-10 11:06:29 -07:00
def update_organization(organization_id):
data = request.get_json()
2023-07-10 11:06:29 -07:00
validate(data, post_update_organization_schema)
2023-07-11 10:58:58 -07:00
result = dao_update_organization(organization_id, **data)
2023-08-29 14:54:30 -07:00
if data.get("agreement_signed") is True:
2023-07-10 11:06:29 -07:00
# if a platform admin has manually adjusted the organization, don't tell people
2023-08-29 14:54:30 -07:00
if data.get("agreement_signed_by_id"):
2023-07-10 11:06:29 -07:00
send_notifications_on_mou_signed(organization_id)
if result:
2023-08-29 14:54:30 -07:00
return "", 204
else:
2023-07-10 11:06:29 -07:00
raise InvalidRequest("Organization not found", 404)
2018-02-10 01:37:17 +00:00
2023-08-29 14:54:30 -07:00
@organization_blueprint.route("/<uuid:organization_id>/service", methods=["POST"])
2023-07-10 11:06:29 -07:00
def link_service_to_organization(organization_id):
2018-02-10 01:37:17 +00:00
data = request.get_json()
2023-07-10 11:06:29 -07:00
validate(data, post_link_service_to_organization_schema)
2023-08-29 14:54:30 -07:00
service = dao_fetch_service_by_id(data["service_id"])
2023-07-10 11:06:29 -07:00
service.organization = None
2018-02-10 01:37:17 +00:00
with transaction():
2023-07-10 11:06:29 -07:00
dao_add_service_to_organization(service, organization_id)
set_default_free_allowance_for_service(service, year_start=None)
2018-02-10 01:37:17 +00:00
2023-08-29 14:54:30 -07:00
return "", 204
2018-02-10 01:37:17 +00:00
2023-08-29 14:54:30 -07:00
@organization_blueprint.route("/<uuid:organization_id>/services", methods=["GET"])
2023-07-10 11:06:29 -07:00
def get_organization_services(organization_id):
services = dao_get_organization_services(organization_id)
sorted_services = sorted(services, key=lambda s: (-s.active, s.name))
return jsonify([s.serialize_for_org_dashboard() for s in sorted_services])
2023-08-29 14:54:30 -07:00
@organization_blueprint.route(
"/<uuid:organization_id>/services-with-usage", methods=["GET"]
)
2023-07-10 11:06:29 -07:00
def get_organization_services_usage(organization_id):
try:
2023-08-29 14:54:30 -07:00
year = int(request.args.get("year", "none"))
except ValueError:
2023-08-29 14:54:30 -07:00
return jsonify(result="error", message="No valid year provided"), 400
2023-07-10 11:06:29 -07:00
services = fetch_usage_year_for_organization(organization_id, year)
list_services = services.values()
2023-08-29 14:54:30 -07:00
sorted_services = sorted(
list_services, key=lambda s: (-s["active"], s["service_name"].lower())
)
return jsonify(services=sorted_services)
2023-08-29 14:54:30 -07:00
@organization_blueprint.route(
"/<uuid:organization_id>/users/<uuid:user_id>", methods=["POST"]
)
2023-07-10 11:06:29 -07:00
def add_user_to_organization(organization_id, user_id):
new_org_user = dao_add_user_to_organization(organization_id, user_id)
return jsonify(data=new_org_user.serialize())
2023-08-29 14:54:30 -07:00
@organization_blueprint.route(
"/<uuid:organization_id>/users/<uuid:user_id>", methods=["DELETE"]
)
2023-07-10 11:06:29 -07:00
def remove_user_from_organization(organization_id, user_id):
organization = dao_get_organization_by_id(organization_id)
user = get_user_by_id(user_id=user_id)
2023-07-10 11:06:29 -07:00
if user not in organization.users:
2023-08-29 14:54:30 -07:00
error = "User not found"
raise InvalidRequest(error, status_code=404)
2023-07-10 11:06:29 -07:00
dao_remove_user_from_organization(organization, user)
return {}, 204
2023-08-29 14:54:30 -07:00
@organization_blueprint.route("/<uuid:organization_id>/users", methods=["GET"])
2023-07-10 11:06:29 -07:00
def get_organization_users(organization_id):
org_users = dao_get_users_for_organization(organization_id)
return jsonify(data=[x.serialize() for x in org_users])
2018-03-06 12:49:46 +00:00
def check_request_args(request):
2023-08-29 14:54:30 -07:00
org_id = request.args.get("org_id")
name = request.args.get("name", None)
2018-03-06 12:49:46 +00:00
errors = []
if not org_id:
2023-08-29 14:54:30 -07:00
errors.append({"org_id": ["Can't be empty"]})
2018-03-06 12:49:46 +00:00
if not name:
2023-08-29 14:54:30 -07:00
errors.append({"name": ["Can't be empty"]})
2018-03-06 12:49:46 +00:00
if errors:
raise InvalidRequest(errors, status_code=400)
return org_id, name
2023-07-10 11:06:29 -07:00
def send_notifications_on_mou_signed(organization_id):
organization = dao_get_organization_by_id(organization_id)
2023-08-29 14:54:30 -07:00
notify_service = dao_fetch_service_by_id(current_app.config["NOTIFY_SERVICE_ID"])
def _send_notification(template_id, recipient, personalisation):
template = dao_get_template_by_id(template_id)
saved_notification = persist_notification(
template_id=template.id,
template_version=template.version,
recipient=recipient,
service=notify_service,
personalisation=personalisation,
notification_type=template.template_type,
api_key_id=None,
key_type=KEY_TYPE_NORMAL,
2023-08-29 14:54:30 -07:00
reply_to_text=notify_service.get_default_reply_to_email_address(),
)
2023-08-25 12:09:00 -07:00
send_notification_to_queue(saved_notification, queue=QueueNames.NOTIFY)
personalisation = {
2023-08-29 14:54:30 -07:00
"mou_link": "{}/agreement/agreement.pdf".format(
current_app.config["ADMIN_BASE_URL"]
),
2023-08-29 14:54:30 -07:00
"org_name": organization.name,
"org_dashboard_link": "{}/organizations/{}".format(
current_app.config["ADMIN_BASE_URL"], organization.id
),
2023-08-29 14:54:30 -07:00
"signed_by_name": organization.agreement_signed_by.name,
"on_behalf_of_name": organization.agreement_signed_on_behalf_of_name,
}
2023-07-10 11:06:29 -07:00
if not organization.agreement_signed_on_behalf_of_email_address:
2023-08-29 14:54:30 -07:00
signer_template_id = "MOU_SIGNER_RECEIPT_TEMPLATE_ID"
else:
2023-08-29 14:54:30 -07:00
signer_template_id = "MOU_SIGNED_ON_BEHALF_SIGNER_RECEIPT_TEMPLATE_ID"
# let the person who has been signed on behalf of know.
_send_notification(
2023-08-29 14:54:30 -07:00
current_app.config["MOU_SIGNED_ON_BEHALF_ON_BEHALF_RECEIPT_TEMPLATE_ID"],
2023-07-10 11:06:29 -07:00
organization.agreement_signed_on_behalf_of_email_address,
2023-08-29 14:54:30 -07:00
personalisation,
)
# let the person who signed know - the template is different depending on if they signed on behalf of someone
_send_notification(
current_app.config[signer_template_id],
2023-07-10 11:06:29 -07:00
organization.agreement_signed_by.email_address,
2023-08-29 14:54:30 -07:00
personalisation,
)