mirror of
https://github.com/GSA/notifications-api.git
synced 2026-02-01 07:35:34 -05:00
Add new email template for the GOV.UK Notify service, to send an email to users that register with the same email address.
Add a new endpoint to send the email.
This commit is contained in:
@@ -174,6 +174,31 @@ def send_user_email_verification(user_id):
|
|||||||
return jsonify({}), 204
|
return jsonify({}), 204
|
||||||
|
|
||||||
|
|
||||||
|
@user.route('/<uuid:user_id>/email-already-registered', methods=['POST'])
|
||||||
|
def send_already_registered_email(user_id):
|
||||||
|
template = dao_get_template_by_id(current_app.config['ALREADY_REGISTERED_EMAIL_TEMPLATE_ID'])
|
||||||
|
to, errors = request_verify_code_schema.load(request.get_json())
|
||||||
|
|
||||||
|
message = {
|
||||||
|
'template': str(template.id),
|
||||||
|
'template_version': template.version,
|
||||||
|
'to': to['to'],
|
||||||
|
'personalisation': {
|
||||||
|
'signin_url': current_app.config['ADMIN_BASE_URL'] + '/sign-in',
|
||||||
|
'forgot_password_url': current_app.config['ADMIN_BASE_URL'] + '/forgot-password',
|
||||||
|
'feedback_url': current_app.config['ADMIN_BASE_URL'] + '/feedback'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
send_email.apply_async((
|
||||||
|
current_app.config['NOTIFY_SERVICE_ID'],
|
||||||
|
str(uuid.uuid4()),
|
||||||
|
encryption.encrypt(message),
|
||||||
|
datetime.utcnow().strftime(DATETIME_FORMAT)
|
||||||
|
), queue='email-already-registered')
|
||||||
|
|
||||||
|
return jsonify({}), 204
|
||||||
|
|
||||||
|
|
||||||
@user.route('/<uuid:user_id>', methods=['GET'])
|
@user.route('/<uuid:user_id>', methods=['GET'])
|
||||||
@user.route('', methods=['GET'])
|
@user.route('', methods=['GET'])
|
||||||
def get_user(user_id=None):
|
def get_user(user_id=None):
|
||||||
|
|||||||
@@ -33,6 +33,7 @@ class Config(object):
|
|||||||
SMS_CODE_TEMPLATE_ID = '36fb0730-6259-4da1-8a80-c8de22ad4246'
|
SMS_CODE_TEMPLATE_ID = '36fb0730-6259-4da1-8a80-c8de22ad4246'
|
||||||
EMAIL_VERIFY_CODE_TEMPLATE_ID = 'ece42649-22a8-4d06-b87f-d52d5d3f0a27'
|
EMAIL_VERIFY_CODE_TEMPLATE_ID = 'ece42649-22a8-4d06-b87f-d52d5d3f0a27'
|
||||||
PASSWORD_RESET_TEMPLATE_ID = '474e9242-823b-4f99-813d-ed392e7f1201'
|
PASSWORD_RESET_TEMPLATE_ID = '474e9242-823b-4f99-813d-ed392e7f1201'
|
||||||
|
ALREADY_REGISTERED_EMAIL_TEMPLATE_ID = '0880fbb1-a0c6-46f0-9a8e-36c986381ceb'
|
||||||
|
|
||||||
BROKER_URL = 'sqs://'
|
BROKER_URL = 'sqs://'
|
||||||
BROKER_TRANSPORT_OPTIONS = {
|
BROKER_TRANSPORT_OPTIONS = {
|
||||||
|
|||||||
56
migrations/versions/0041_email_template_.py
Normal file
56
migrations/versions/0041_email_template_.py
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
"""empty message
|
||||||
|
|
||||||
|
Revision ID: 0041_email_template
|
||||||
|
Revises: 0040_adjust_mmg_provider_rate
|
||||||
|
Create Date: 2016-07-07 16:02:06.241769
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
revision = '0041_email_template'
|
||||||
|
down_revision = '0040_adjust_mmg_provider_rate'
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
user_id = '6af522d0-2915-4e52-83a3-3690455a5fe6'
|
||||||
|
service_id = 'd6aa2c68-a2d9-4437-ab19-3ae8eb202553'
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade():
|
||||||
|
template_history_insert = """INSERT INTO templates_history (id, name, template_type, created_at,
|
||||||
|
content, archived, service_id,
|
||||||
|
subject, created_by_id, version)
|
||||||
|
VALUES ('{}', '{}', '{}', '{}', '{}', False, '{}', '{}', '{}', 1)
|
||||||
|
"""
|
||||||
|
template_insert = """INSERT INTO templates (id, name, template_type, created_at,
|
||||||
|
content, archived, service_id, subject, created_by_id, version)
|
||||||
|
VALUES ('{}', '{}', '{}', '{}', '{}', False, '{}', '{}', '{}', 1)
|
||||||
|
"""
|
||||||
|
content = """You already have a GOV.UK Notify account with this email address.
|
||||||
|
|
||||||
|
Sign in here: ((signin_url))
|
||||||
|
|
||||||
|
If you’ve forgotten your password, you can reset it here: ((forgot_password_url))
|
||||||
|
|
||||||
|
|
||||||
|
If you didn’t try to register for a GOV.UK Notify account recently, please let us know here: ((feedback_url))"""
|
||||||
|
|
||||||
|
op.get_bind()
|
||||||
|
op.execute(template_history_insert.format('0880fbb1-a0c6-46f0-9a8e-36c986381ceb',
|
||||||
|
'Your GOV.UK Notify account', 'email',
|
||||||
|
datetime.utcnow(), content, service_id,
|
||||||
|
'Your GOV.UK Notify account', user_id))
|
||||||
|
op.execute(
|
||||||
|
template_insert.format('0880fbb1-a0c6-46f0-9a8e-36c986381ceb', 'Your GOV.UK Notify account', 'email',
|
||||||
|
datetime.utcnow(), content, service_id,
|
||||||
|
'Your GOV.UK Notify account', user_id))
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade():
|
||||||
|
op.execute("delete from notifications where template_id = '0880fbb1-a0c6-46f0-9a8e-36c986381ceb'")
|
||||||
|
op.execute("delete from jobs where template_id = '0880fbb1-a0c6-46f0-9a8e-36c986381ceb'")
|
||||||
|
op.execute("delete from template_statistics where template_id = '0880fbb1-a0c6-46f0-9a8e-36c986381ceb'")
|
||||||
|
op.execute("delete from templates_history where id = '0880fbb1-a0c6-46f0-9a8e-36c986381ceb'")
|
||||||
|
op.execute("delete from templates where id = '0880fbb1-a0c6-46f0-9a8e-36c986381ceb'")
|
||||||
@@ -699,3 +699,38 @@ def password_reset_email_template(notify_db,
|
|||||||
template = Template(**data)
|
template = Template(**data)
|
||||||
db.session.add(template)
|
db.session.add(template)
|
||||||
return template
|
return template
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope='function')
|
||||||
|
def already_registered_template(notify_db,
|
||||||
|
notify_db_session):
|
||||||
|
user = sample_user(notify_db, notify_db_session)
|
||||||
|
service = Service.query.get(current_app.config['NOTIFY_SERVICE_ID'])
|
||||||
|
if not service:
|
||||||
|
data = {
|
||||||
|
'id': current_app.config['NOTIFY_SERVICE_ID'],
|
||||||
|
'name': 'Notify Service',
|
||||||
|
'message_limit': 1000,
|
||||||
|
'active': True,
|
||||||
|
'restricted': False,
|
||||||
|
'email_from': 'notify.service',
|
||||||
|
'created_by': user
|
||||||
|
}
|
||||||
|
service = Service(**data)
|
||||||
|
db.session.add(service)
|
||||||
|
|
||||||
|
template = Template.query.get(current_app.config['ALREADY_REGISTERED_EMAIL_TEMPLATE_ID'])
|
||||||
|
if not template:
|
||||||
|
data = {
|
||||||
|
'id': current_app.config['ALREADY_REGISTERED_EMAIL_TEMPLATE_ID'],
|
||||||
|
'name': 'ALREADY_REGISTERED_EMAIL_TEMPLATE_ID',
|
||||||
|
'template_type': 'email',
|
||||||
|
'content': """Sign in here: ((signin_url)) If you’ve forgotten your password,
|
||||||
|
you can reset it here: ((forgot_password_url)) feedback:((feedback_url))""",
|
||||||
|
'service': service,
|
||||||
|
'created_by': user,
|
||||||
|
'archived': False
|
||||||
|
}
|
||||||
|
template = Template(**data)
|
||||||
|
db.session.add(template)
|
||||||
|
return template
|
||||||
|
|||||||
@@ -455,3 +455,35 @@ def test_send_user_reset_password_should_return_400_when_data_is_not_email_addre
|
|||||||
|
|
||||||
assert resp.status_code == 400
|
assert resp.status_code == 400
|
||||||
assert json.loads(resp.get_data(as_text=True))['message'] == {'email': ['Not a valid email address']}
|
assert json.loads(resp.get_data(as_text=True))['message'] == {'email': ['Not a valid email address']}
|
||||||
|
|
||||||
|
|
||||||
|
@freeze_time("2016-01-01 11:09:00.061258")
|
||||||
|
def test_send_already_registered_email(notify_api, sample_user, already_registered_template, mocker):
|
||||||
|
with notify_api.test_request_context():
|
||||||
|
with notify_api.test_client() as client:
|
||||||
|
data = json.dumps({'to': sample_user.email_address})
|
||||||
|
auth_header = create_authorization_header()
|
||||||
|
mocker.patch('app.celery.tasks.send_email.apply_async')
|
||||||
|
mocker.patch('uuid.uuid4', return_value='some_uuid') # for the notification id
|
||||||
|
|
||||||
|
resp = client.post(
|
||||||
|
url_for('user.send_already_registered_email', user_id=str(sample_user.id)),
|
||||||
|
data=data,
|
||||||
|
headers=[('Content-Type', 'application/json'), auth_header])
|
||||||
|
assert resp.status_code == 204
|
||||||
|
message = {
|
||||||
|
'template': str(already_registered_template.id),
|
||||||
|
'template_version': already_registered_template.version,
|
||||||
|
'to': sample_user.email_address,
|
||||||
|
'personalisation': {
|
||||||
|
'signin_url': current_app.config['ADMIN_BASE_URL'] + '/sign-in',
|
||||||
|
'forgot_password_url': current_app.config['ADMIN_BASE_URL'] + '/forgot-password',
|
||||||
|
'feedback_url': current_app.config['ADMIN_BASE_URL'] + '/feedback'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
app.celery.tasks.send_email.apply_async.assert_called_once_with(
|
||||||
|
(str(current_app.config['NOTIFY_SERVICE_ID']),
|
||||||
|
'some_uuid',
|
||||||
|
app.encryption.encrypt(message),
|
||||||
|
"2016-01-01T11:09:00.061258"),
|
||||||
|
queue="email-already-registered")
|
||||||
|
|||||||
Reference in New Issue
Block a user