Rename the current s3 logo client functions

We will be adding methods to deal with letter logos, so this adds 'email' to
the method names for email logos to avoid confusion later.
This commit is contained in:
Katie Smith
2019-01-30 10:57:35 +00:00
parent f005d7a569
commit d654a87f5c
4 changed files with 68 additions and 68 deletions

View File

@@ -6,11 +6,11 @@ from app.main import main
from app.main.forms import SearchTemplatesForm, ServiceUpdateEmailBranding
from app.s3_client.s3_logo_client import (
TEMP_TAG,
delete_temp_file,
delete_temp_files_created_by,
permanent_logo_name,
delete_email_temp_file,
delete_email_temp_files_created_by,
permanent_email_logo_name,
persist_logo,
upload_logo,
upload_email_logo,
)
from app.utils import AgreementInfo, get_logo_cdn_domain, user_is_platform_admin
@@ -49,7 +49,7 @@ def update_email_branding(branding_id, logo=None):
if form.validate_on_submit():
if form.file.data:
upload_filename = upload_logo(
upload_filename = upload_email_logo(
form.file.data.filename,
form.file.data,
current_app.config['AWS_REGION'],
@@ -57,11 +57,11 @@ def update_email_branding(branding_id, logo=None):
)
if logo and logo.startswith(TEMP_TAG.format(user_id=session['user_id'])):
delete_temp_file(logo)
delete_email_temp_file(logo)
return redirect(url_for('.update_email_branding', branding_id=branding_id, logo=upload_filename))
updated_logo_name = permanent_logo_name(logo, session["user_id"]) if logo else None
updated_logo_name = permanent_email_logo_name(logo, session["user_id"]) if logo else None
email_branding_client.update_email_branding(
branding_id=branding_id,
@@ -76,7 +76,7 @@ def update_email_branding(branding_id, logo=None):
if logo:
persist_logo(logo, updated_logo_name)
delete_temp_files_created_by(session["user_id"])
delete_email_temp_files_created_by(session["user_id"])
return redirect(url_for('.email_branding', branding_id=branding_id))
@@ -98,7 +98,7 @@ def create_email_branding(logo=None):
if form.validate_on_submit():
if form.file.data:
upload_filename = upload_logo(
upload_filename = upload_email_logo(
form.file.data.filename,
form.file.data,
current_app.config['AWS_REGION'],
@@ -106,11 +106,11 @@ def create_email_branding(logo=None):
)
if logo and logo.startswith(TEMP_TAG.format(user_id=session['user_id'])):
delete_temp_file(logo)
delete_email_temp_file(logo)
return redirect(url_for('.create_email_branding', logo=upload_filename))
updated_logo_name = permanent_logo_name(logo, session["user_id"]) if logo else None
updated_logo_name = permanent_email_logo_name(logo, session["user_id"]) if logo else None
email_branding_client.create_email_branding(
logo=updated_logo_name,
@@ -124,7 +124,7 @@ def create_email_branding(logo=None):
if logo:
persist_logo(logo, updated_logo_name)
delete_temp_files_created_by(session["user_id"])
delete_email_temp_files_created_by(session["user_id"])
return redirect(url_for('.email_branding'))

View File

@@ -5,7 +5,7 @@ from flask import current_app
from notifications_utils.s3 import s3upload as utils_s3upload
TEMP_TAG = 'temp-{user_id}_'
LOGO_LOCATION_STRUCTURE = '{temp}{unique_id}-{filename}'
EMAIL_LOGO_LOCATION_STRUCTURE = '{temp}{unique_id}-{filename}'
def get_s3_object(bucket_name, filename):
@@ -33,12 +33,12 @@ def get_s3_objects_filter_by_prefix(prefix):
return s3.Bucket(bucket_name).objects.filter(Prefix=prefix)
def get_temp_truncated_filename(filename, user_id):
def get_temp_truncated_email_filename(filename, user_id):
return filename[len(TEMP_TAG.format(user_id=user_id)):]
def upload_logo(filename, filedata, region, user_id):
upload_file_name = LOGO_LOCATION_STRUCTURE.format(
def upload_email_logo(filename, filedata, region, user_id):
upload_file_name = EMAIL_LOGO_LOCATION_STRUCTURE.format(
temp=TEMP_TAG.format(user_id=user_id),
unique_id=str(uuid.uuid4()),
filename=filename
@@ -55,19 +55,19 @@ def upload_logo(filename, filedata, region, user_id):
return upload_file_name
def permanent_logo_name(filename, user_id):
def permanent_email_logo_name(filename, user_id):
if filename.startswith(TEMP_TAG.format(user_id=user_id)):
return get_temp_truncated_filename(filename=filename, user_id=user_id)
return get_temp_truncated_email_filename(filename=filename, user_id=user_id)
else:
return filename
def delete_temp_files_created_by(user_id):
def delete_email_temp_files_created_by(user_id):
for obj in get_s3_objects_filter_by_prefix(TEMP_TAG.format(user_id=user_id)):
delete_s3_object(obj.key)
def delete_temp_file(filename):
def delete_email_temp_file(filename):
if not filename.startswith(TEMP_TAG[:5]):
raise ValueError('Not a temp file: {}'.format(filename))