rename invite blueprints

nb: the routes are not changing as part of this, only file paths and
blueprint names.

invite -> service_invite

this blueprint handles fetching invites for a service, creating invites,
etc.

accept_invite -> global_invite

this blueprint handles accepting invites for now, but will also involve
retrieving service/org user invite data without knowing the service/org
id associated. i'm not in love with this name and open to suggestions,
but i wanted to contrast it from service_invite and
organisation/invite_rest.py.
This commit is contained in:
Leo Hemsted
2021-03-05 20:13:56 +00:00
parent b0c531f5cb
commit d94d0bc8d7
10 changed files with 23 additions and 21 deletions

View File

@@ -136,7 +136,6 @@ def create_app(application):
def register_blueprint(application): def register_blueprint(application):
from app.accept_invite.rest import accept_invite
from app.authentication.auth import ( from app.authentication.auth import (
requires_admin_auth, requires_admin_auth,
requires_auth, requires_auth,
@@ -147,9 +146,9 @@ def register_blueprint(application):
from app.complaint.complaint_rest import complaint_blueprint from app.complaint.complaint_rest import complaint_blueprint
from app.email_branding.rest import email_branding_blueprint from app.email_branding.rest import email_branding_blueprint
from app.events.rest import events as events_blueprint from app.events.rest import events as events_blueprint
from app.global_invite.rest import global_invite_blueprint
from app.inbound_number.rest import inbound_number_blueprint from app.inbound_number.rest import inbound_number_blueprint
from app.inbound_sms.rest import inbound_sms as inbound_sms_blueprint from app.inbound_sms.rest import inbound_sms as inbound_sms_blueprint
from app.invite.rest import invite as invite_blueprint
from app.job.rest import job_blueprint from app.job.rest import job_blueprint
from app.letter_branding.letter_branding_rest import ( from app.letter_branding.letter_branding_rest import (
letter_branding_blueprint, letter_branding_blueprint,
@@ -174,6 +173,9 @@ def register_blueprint(application):
) )
from app.service.callback_rest import service_callback_blueprint from app.service.callback_rest import service_callback_blueprint
from app.service.rest import service_blueprint from app.service.rest import service_blueprint
from app.service_invite.rest import (
service_invite as service_invite_blueprint,
)
from app.status.healthcheck import status as status_blueprint from app.status.healthcheck import status as status_blueprint
from app.template.rest import template_blueprint from app.template.rest import template_blueprint
from app.template_folder.rest import template_folder_blueprint from app.template_folder.rest import template_folder_blueprint
@@ -210,8 +212,8 @@ def register_blueprint(application):
job_blueprint.before_request(requires_admin_auth) job_blueprint.before_request(requires_admin_auth)
application.register_blueprint(job_blueprint) application.register_blueprint(job_blueprint)
invite_blueprint.before_request(requires_admin_auth) service_invite_blueprint.before_request(requires_admin_auth)
application.register_blueprint(invite_blueprint) application.register_blueprint(service_invite_blueprint)
inbound_number_blueprint.before_request(requires_admin_auth) inbound_number_blueprint.before_request(requires_admin_auth)
application.register_blueprint(inbound_number_blueprint) application.register_blueprint(inbound_number_blueprint)
@@ -219,8 +221,8 @@ def register_blueprint(application):
inbound_sms_blueprint.before_request(requires_admin_auth) inbound_sms_blueprint.before_request(requires_admin_auth)
application.register_blueprint(inbound_sms_blueprint) application.register_blueprint(inbound_sms_blueprint)
accept_invite.before_request(requires_admin_auth) global_invite_blueprint.before_request(requires_admin_auth)
application.register_blueprint(accept_invite, url_prefix='/invite') application.register_blueprint(global_invite_blueprint, url_prefix='/invite')
template_statistics_blueprint.before_request(requires_admin_auth) template_statistics_blueprint.before_request(requires_admin_auth)
application.register_blueprint(template_statistics_blueprint) application.register_blueprint(template_statistics_blueprint)

View File

@@ -570,7 +570,7 @@ def bulk_invite_user_to_service(file_name, service_id, user_id, auth_type, permi
# platform_admin # platform_admin
# view_activity # view_activity
# "send_texts,send_emails,send_letters,view_activity" # "send_texts,send_emails,send_letters,view_activity"
from app.invite.rest import create_invited_user from app.service_invite.rest import create_invited_user
file = open(file_name) file = open(file_name)
for email_address in file: for email_address in file:
data = { data = {

View File

@@ -7,11 +7,11 @@ from app.dao.organisation_dao import dao_get_invited_organisation_user
from app.errors import InvalidRequest, register_errors from app.errors import InvalidRequest, register_errors
from app.schemas import invited_user_schema from app.schemas import invited_user_schema
accept_invite = Blueprint('accept_invite', __name__) global_invite_blueprint = Blueprint('global_invite', __name__)
register_errors(accept_invite) register_errors(global_invite_blueprint)
@accept_invite.route('/<invitation_type>/<token>', methods=['GET']) @global_invite_blueprint.route('/<invitation_type>/<token>', methods=['GET'])
def validate_invitation_token(invitation_type, token): def validate_invitation_token(invitation_type, token):
max_age_seconds = 60 * 60 * 24 * current_app.config['INVITATION_EXPIRATION_DAYS'] max_age_seconds = 60 * 60 * 24 * current_app.config['INVITATION_EXPIRATION_DAYS']

View File

@@ -15,12 +15,12 @@ from app.notifications.process_notifications import (
) )
from app.schemas import invited_user_schema from app.schemas import invited_user_schema
invite = Blueprint('invite', __name__, url_prefix='/service/<service_id>/invite') service_invite = Blueprint('service_invite', __name__, url_prefix='/service/<service_id>/invite')
register_errors(invite) register_errors(service_invite)
@invite.route('', methods=['POST']) @service_invite.route('', methods=['POST'])
def create_invited_user(service_id): def create_invited_user(service_id):
request_json = request.get_json() request_json = request.get_json()
invited_user, errors = invited_user_schema.load(request_json) invited_user, errors = invited_user_schema.load(request_json)
@@ -58,19 +58,19 @@ def create_invited_user(service_id):
return jsonify(data=invited_user_schema.dump(invited_user).data), 201 return jsonify(data=invited_user_schema.dump(invited_user).data), 201
@invite.route('', methods=['GET']) @service_invite.route('', methods=['GET'])
def get_invited_users_by_service(service_id): def get_invited_users_by_service(service_id):
invited_users = get_invited_users_for_service(service_id) invited_users = get_invited_users_for_service(service_id)
return jsonify(data=invited_user_schema.dump(invited_users, many=True).data), 200 return jsonify(data=invited_user_schema.dump(invited_users, many=True).data), 200
@invite.route('/<invited_user_id>', methods=['GET']) @service_invite.route('/<invited_user_id>', methods=['GET'])
def get_invited_user_by_service(service_id, invited_user_id): def get_invited_user_by_service(service_id, invited_user_id):
invited_user = get_invited_user(service_id, invited_user_id) invited_user = get_invited_user(service_id, invited_user_id)
return jsonify(data=invited_user_schema.dump(invited_user).data), 200 return jsonify(data=invited_user_schema.dump(invited_user).data), 200
@invite.route('/<invited_user_id>', methods=['POST']) @service_invite.route('/<invited_user_id>', methods=['POST'])
def update_invited_user(service_id, invited_user_id): def update_invited_user(service_id, invited_user_id):
fetched = get_invited_user(service_id=service_id, invited_user_id=invited_user_id) fetched = get_invited_user(service_id=service_id, invited_user_id=invited_user_id)

View File

@@ -41,7 +41,7 @@ def test_create_invited_user(
) )
json_resp = admin_request.post( json_resp = admin_request.post(
'invite.create_invited_user', 'service_invite.create_invited_user',
service_id=sample_service.id, service_id=sample_service.id,
_data=data, _data=data,
_expected_status=201 _expected_status=201
@@ -102,7 +102,7 @@ def test_invited_user_for_broadcast_service_receives_broadcast_invite_email(
) )
admin_request.post( admin_request.post(
'invite.create_invited_user', 'service_invite.create_invited_user',
service_id=sample_broadcast_service.id, service_id=sample_broadcast_service.id,
_data=data, _data=data,
_expected_status=201 _expected_status=201
@@ -136,7 +136,7 @@ def test_create_invited_user_without_auth_type(admin_request, sample_service, mo
} }
json_resp = admin_request.post( json_resp = admin_request.post(
'invite.create_invited_user', 'service_invite.create_invited_user',
service_id=sample_service.id, service_id=sample_service.id,
_data=data, _data=data,
_expected_status=201 _expected_status=201
@@ -218,7 +218,7 @@ def test_get_invited_users_by_service_with_no_invites(client, notify_db, notify_
def test_get_invited_user_by_service(admin_request, sample_invited_user): def test_get_invited_user_by_service(admin_request, sample_invited_user):
json_resp = admin_request.get( json_resp = admin_request.get(
'invite.get_invited_user_by_service', 'service_invite.get_invited_user_by_service',
service_id=sample_invited_user.service.id, service_id=sample_invited_user.service.id,
invited_user_id=sample_invited_user.id invited_user_id=sample_invited_user.id
) )
@@ -231,7 +231,7 @@ def test_get_invited_user_by_service_when_user_does_not_belong_to_the_service(
fake_uuid, fake_uuid,
): ):
json_resp = admin_request.get( json_resp = admin_request.get(
'invite.get_invited_user_by_service', 'service_invite.get_invited_user_by_service',
service_id=fake_uuid, service_id=fake_uuid,
invited_user_id=sample_invited_user.id, invited_user_id=sample_invited_user.id,
_expected_status=404 _expected_status=404