darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-08-19 05:59:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12 from 18F/jim/071922/cachecomment

Browse Source 
comment cache decorator
This commit is contained in:
Jim Moffet
2022-07-19 18:32:28 -07:00
committed by GitHub
parent 845ecdd17f f1d9aef9cd
commit 4a6d3fee2d
12 changed files with 120 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
app/notify_client/broadcast_message_api_client.py
View File

@@ -34,18 +34,18 @@ class BroadcastMessageAPIClient(NotifyAdminAPIClient):
def get_broadcast_messages(self, service_id): def get_broadcast_messages(self, service_id):
return self.get(f'/service/{service_id}/broadcast-message')['broadcast_messages'] return self.get(f'/service/{service_id}/broadcast-message')['broadcast_messages']
@cache.set('service-{service_id}-broadcast-message-{broadcast_message_id}') # @cache.set('service-{service_id}-broadcast-message-{broadcast_message_id}')
def get_broadcast_message(self, *, service_id, broadcast_message_id): def get_broadcast_message(self, *, service_id, broadcast_message_id):
return self.get(f'/service/{service_id}/broadcast-message/{broadcast_message_id}') return self.get(f'/service/{service_id}/broadcast-message/{broadcast_message_id}')
@cache.delete('service-{service_id}-broadcast-message-{broadcast_message_id}') # @cache.delete('service-{service_id}-broadcast-message-{broadcast_message_id}')
def update_broadcast_message(self, *, service_id, broadcast_message_id, data): def update_broadcast_message(self, *, service_id, broadcast_message_id, data):
self.post( self.post(
f'/service/{service_id}/broadcast-message/{broadcast_message_id}', f'/service/{service_id}/broadcast-message/{broadcast_message_id}',
data=data, data=data,
) )
@cache.delete('service-{service_id}-broadcast-message-{broadcast_message_id}') # @cache.delete('service-{service_id}-broadcast-message-{broadcast_message_id}')
def update_broadcast_message_status(self, status, *, service_id, broadcast_message_id): def update_broadcast_message_status(self, status, *, service_id, broadcast_message_id):
data = _attach_current_user({ data = _attach_current_user({
'status': status, 'status': status,

10
app/notify_client/email_branding_client.py
View File

@@ -3,18 +3,18 @@ from app.notify_client import NotifyAdminAPIClient, cache
class EmailBrandingClient(NotifyAdminAPIClient): class EmailBrandingClient(NotifyAdminAPIClient):
@cache.set('email_branding-{branding_id}') # @cache.set('email_branding-{branding_id}')
def get_email_branding(self, branding_id): def get_email_branding(self, branding_id):
return self.get(url='/email-branding/{}'.format(branding_id)) return self.get(url='/email-branding/{}'.format(branding_id))
@cache.set('email_branding') # @cache.set('email_branding')
def get_all_email_branding(self, sort_key=None): def get_all_email_branding(self, sort_key=None):
brandings = self.get(url='/email-branding')['email_branding'] brandings = self.get(url='/email-branding')['email_branding']
if sort_key and sort_key in brandings[0]: if sort_key and sort_key in brandings[0]:
brandings.sort(key=lambda branding: branding[sort_key].lower()) brandings.sort(key=lambda branding: branding[sort_key].lower())
return brandings return brandings
@cache.delete('email_branding') # @cache.delete('email_branding')
def create_email_branding(self, logo, name, text, colour, brand_type): def create_email_branding(self, logo, name, text, colour, brand_type):
data = { data = {
"logo": logo, "logo": logo,
@@ -25,8 +25,8 @@ class EmailBrandingClient(NotifyAdminAPIClient):
} }
return self.post(url="/email-branding", data=data) return self.post(url="/email-branding", data=data)
@cache.delete('email_branding') # @cache.delete('email_branding')
@cache.delete('email_branding-{branding_id}') # @cache.delete('email_branding-{branding_id}')
def update_email_branding(self, branding_id, logo, name, text, colour, brand_type): def update_email_branding(self, branding_id, logo, name, text, colour, brand_type):
data = { data = {
"logo": logo, "logo": logo,

4
app/notify_client/invite_api_client.py
View File

@@ -64,8 +64,8 @@ class InviteApiClient(NotifyAdminAPIClient):
self.post(url='/service/{0}/invite/{1}'.format(service_id, invited_user_id), self.post(url='/service/{0}/invite/{1}'.format(service_id, invited_user_id),
data=data) data=data)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete('user-{invited_user_id}') # @cache.delete('user-{invited_user_id}')
def accept_invite(self, service_id, invited_user_id): def accept_invite(self, service_id, invited_user_id):
data = {'status': 'accepted'} data = {'status': 'accepted'}
self.post(url='/service/{0}/invite/{1}'.format(service_id, invited_user_id), self.post(url='/service/{0}/invite/{1}'.format(service_id, invited_user_id),

6
app/notify_client/job_api_client.py
View File

@@ -84,7 +84,7 @@ class JobApiClient(NotifyAdminAPIClient):
url=f'/service/{service_id}/job/scheduled-job-stats' url=f'/service/{service_id}/job/scheduled-job-stats'
) )
@cache.set('has_jobs-{service_id}') # @cache.set('has_jobs-{service_id}')
def has_jobs(self, service_id): def has_jobs(self, service_id):
return bool(self.get_jobs(service_id)['data']) return bool(self.get_jobs(service_id)['data'])
@@ -108,14 +108,14 @@ class JobApiClient(NotifyAdminAPIClient):
return job return job
@cache.delete('has_jobs-{service_id}') # @cache.delete('has_jobs-{service_id}')
def cancel_job(self, service_id, job_id): def cancel_job(self, service_id, job_id):
return self.post( return self.post(
url='/service/{}/job/{}/cancel'.format(service_id, job_id), url='/service/{}/job/{}/cancel'.format(service_id, job_id),
data={} data={}
) )
@cache.delete('has_jobs-{service_id}') # @cache.delete('has_jobs-{service_id}')
def cancel_letter_job(self, service_id, job_id): def cancel_letter_job(self, service_id, job_id):
return self.post( return self.post(
url='/service/{}/job/{}/cancel-letter-job'.format(service_id, job_id), url='/service/{}/job/{}/cancel-letter-job'.format(service_id, job_id),

10
app/notify_client/letter_branding_client.py
View File

@@ -3,15 +3,15 @@ from app.notify_client import NotifyAdminAPIClient, cache
class LetterBrandingClient(NotifyAdminAPIClient): class LetterBrandingClient(NotifyAdminAPIClient):
@cache.set('letter_branding-{branding_id}') # @cache.set('letter_branding-{branding_id}')
def get_letter_branding(self, branding_id): def get_letter_branding(self, branding_id):
return self.get(url='/letter-branding/{}'.format(branding_id)) return self.get(url='/letter-branding/{}'.format(branding_id))
@cache.set('letter_branding') # @cache.set('letter_branding')
def get_all_letter_branding(self): def get_all_letter_branding(self):
return self.get(url='/letter-branding') return self.get(url='/letter-branding')
@cache.delete('letter_branding') # @cache.delete('letter_branding')
def create_letter_branding(self, filename, name): def create_letter_branding(self, filename, name):
data = { data = {
"filename": filename, "filename": filename,
@@ -19,8 +19,8 @@ class LetterBrandingClient(NotifyAdminAPIClient):
} }
return self.post(url="/letter-branding", data=data) return self.post(url="/letter-branding", data=data)
@cache.delete('letter_branding') # @cache.delete('letter_branding')
@cache.delete('letter_branding-{branding_id}') # @cache.delete('letter_branding-{branding_id}')
def update_letter_branding(self, branding_id, filename, name): def update_letter_branding(self, branding_id, filename, name):
data = { data = {
"filename": filename, "filename": filename,

20
app/notify_client/organisations_api_client.py
View File

@@ -8,11 +8,11 @@ from app.notify_client import NotifyAdminAPIClient, cache
class OrganisationsClient(NotifyAdminAPIClient): class OrganisationsClient(NotifyAdminAPIClient):
@cache.set('organisations') # @cache.set('organisations')
def get_organisations(self): def get_organisations(self):
return self.get(url='/organisations') return self.get(url='/organisations')
@cache.set('domains') # @cache.set('domains')
def get_domains(self): def get_domains(self):
return list(chain.from_iterable( return list(chain.from_iterable(
organisation['domains'] organisation['domains']
@@ -22,7 +22,7 @@ class OrganisationsClient(NotifyAdminAPIClient):
def get_organisation(self, org_id): def get_organisation(self, org_id):
return self.get(url='/organisations/{}'.format(org_id)) return self.get(url='/organisations/{}'.format(org_id))
@cache.set('organisation-{org_id}-name') # @cache.set('organisation-{org_id}-name')
def get_organisation_name(self, org_id): def get_organisation_name(self, org_id):
return self.get_organisation(org_id)['name'] return self.get_organisation(org_id)['name']
@@ -36,7 +36,7 @@ class OrganisationsClient(NotifyAdminAPIClient):
return None return None
raise error raise error
@cache.delete('organisations') # @cache.delete('organisations')
def create_organisation(self, name, crown, organisation_type, agreement_signed): def create_organisation(self, name, crown, organisation_type, agreement_signed):
return self.post( return self.post(
url="/organisations", url="/organisations",
@@ -48,8 +48,8 @@ class OrganisationsClient(NotifyAdminAPIClient):
} }
) )
@cache.delete('domains') # @cache.delete('domains')
@cache.delete('organisations') # @cache.delete('organisations')
def update_organisation(self, org_id, cached_service_ids=None, **kwargs): def update_organisation(self, org_id, cached_service_ids=None, **kwargs):
api_response = self.post(url="/organisations/{}".format(org_id), data=kwargs) api_response = self.post(url="/organisations/{}".format(org_id), data=kwargs)
@@ -61,9 +61,9 @@ class OrganisationsClient(NotifyAdminAPIClient):
return api_response return api_response
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete('live-service-and-organisation-counts') # @cache.delete('live-service-and-organisation-counts')
@cache.delete('organisations') # @cache.delete('organisations')
def update_service_organisation(self, service_id, org_id): def update_service_organisation(self, service_id, org_id):
data = { data = {
'service_id': service_id 'service_id': service_id
@@ -76,7 +76,7 @@ class OrganisationsClient(NotifyAdminAPIClient):
def get_organisation_services(self, org_id): def get_organisation_services(self, org_id):
return self.get(url="/organisations/{}/services".format(org_id)) return self.get(url="/organisations/{}/services".format(org_id))
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def remove_user_from_organisation(self, org_id, user_id): def remove_user_from_organisation(self, org_id, user_id):
return self.delete(f'/organisations/{org_id}/users/{user_id}') return self.delete(f'/organisations/{org_id}/users/{user_id}')

2
app/notify_client/performance_dashboard_api_client.py
View File

@@ -3,7 +3,7 @@ from app.notify_client import NotifyAdminAPIClient, cache
class PerformanceDashboardAPIClient(NotifyAdminAPIClient): class PerformanceDashboardAPIClient(NotifyAdminAPIClient):
@cache.set('performance-stats-{start_date}-to-{end_date}', ttl_in_seconds=3600) # @cache.set('performance-stats-{start_date}-to-{end_date}', ttl_in_seconds=3600)
def get_performance_dashboard_stats( def get_performance_dashboard_stats(
self, self,
*, *,

114
app/notify_client/service_api_client.py
View File

@@ -7,7 +7,7 @@ from app.notify_client import NotifyAdminAPIClient, _attach_current_user, cache
class ServiceAPIClient(NotifyAdminAPIClient): class ServiceAPIClient(NotifyAdminAPIClient):
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def create_service( def create_service(
self, self,
service_name, service_name,
@@ -32,7 +32,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
data = _attach_current_user(data) data = _attach_current_user(data)
return self.post("/service", data)['data']['id'] return self.post("/service", data)['data']['id']
@cache.set('service-{service_id}') # @cache.set('service-{service_id}')
def get_service(self, service_id): def get_service(self, service_id):
""" """
Retrieve a service. Retrieve a service.
@@ -64,7 +64,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
params_dict['only_active'] = True params_dict['only_active'] = True
return self.get_services(params_dict) return self.get_services(params_dict)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def update_service( def update_service(
self, self,
service_id, service_id,
@@ -114,7 +114,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
endpoint = "/service/{0}".format(service_id) endpoint = "/service/{0}".format(service_id)
return self.post(endpoint, data) return self.post(endpoint, data)
@cache.delete('live-service-and-organisation-counts') # @cache.delete('live-service-and-organisation-counts')
def update_status(self, service_id, live): def update_status(self, service_id, live):
return self.update_service( return self.update_service(
service_id, service_id,
@@ -123,7 +123,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
go_live_at=str(datetime.utcnow()) if live else None go_live_at=str(datetime.utcnow()) if live else None
) )
@cache.delete('live-service-and-organisation-counts') # @cache.delete('live-service-and-organisation-counts')
def update_count_as_live(self, service_id, count_as_live): def update_count_as_live(self, service_id, count_as_live):
return self.update_service( return self.update_service(
service_id, service_id,
@@ -134,24 +134,24 @@ class ServiceAPIClient(NotifyAdminAPIClient):
def update_service_with_properties(self, service_id, properties): def update_service_with_properties(self, service_id, properties):
return self.update_service(service_id, **properties) return self.update_service(service_id, **properties)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete('service-{service_id}-templates') # @cache.delete('service-{service_id}-templates')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def archive_service(self, service_id, cached_service_user_ids): def archive_service(self, service_id, cached_service_user_ids):
if cached_service_user_ids: if cached_service_user_ids:
redis_client.delete(*map('user-{}'.format, cached_service_user_ids)) redis_client.delete(*map('user-{}'.format, cached_service_user_ids))
return self.post('/service/{}/archive'.format(service_id), data=None) return self.post('/service/{}/archive'.format(service_id), data=None)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def suspend_service(self, service_id): def suspend_service(self, service_id):
return self.post('/service/{}/suspend'.format(service_id), data=None) return self.post('/service/{}/suspend'.format(service_id), data=None)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def resume_service(self, service_id): def resume_service(self, service_id):
return self.post('/service/{}/resume'.format(service_id), data=None) return self.post('/service/{}/resume'.format(service_id), data=None)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def remove_user_from_service(self, service_id, user_id): def remove_user_from_service(self, service_id, user_id):
""" """
Remove a user from a service Remove a user from a service
@@ -162,7 +162,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
data = _attach_current_user({}) data = _attach_current_user({})
return self.delete(endpoint, data) return self.delete(endpoint, data)
@cache.delete('service-{service_id}-templates') # @cache.delete('service-{service_id}-templates')
def create_service_template(self, name, type_, content, service_id, subject=None, process_type='normal', def create_service_template(self, name, type_, content, service_id, subject=None, process_type='normal',
parent_folder_id=None): parent_folder_id=None):
""" """
@@ -187,8 +187,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
endpoint = "/service/{0}/template".format(service_id) endpoint = "/service/{0}/template".format(service_id)
return self.post(endpoint, data) return self.post(endpoint, data)
@cache.delete('service-{service_id}-templates') # @cache.delete('service-{service_id}-templates')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def update_service_template( def update_service_template(
self, id_, name, type_, content, service_id, subject=None, process_type=None self, id_, name, type_, content, service_id, subject=None, process_type=None
): ):
@@ -214,8 +214,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
endpoint = "/service/{0}/template/{1}".format(service_id, id_) endpoint = "/service/{0}/template/{1}".format(service_id, id_)
return self.post(endpoint, data) return self.post(endpoint, data)
@cache.delete('service-{service_id}-templates') # @cache.delete('service-{service_id}-templates')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def redact_service_template(self, service_id, id_): def redact_service_template(self, service_id, id_):
return self.post( return self.post(
"/service/{}/template/{}".format(service_id, id_), "/service/{}/template/{}".format(service_id, id_),
@@ -224,8 +224,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
), ),
) )
@cache.delete('service-{service_id}-templates') # @cache.delete('service-{service_id}-templates')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def update_service_template_sender(self, service_id, template_id, reply_to): def update_service_template_sender(self, service_id, template_id, reply_to):
data = { data = {
'reply_to': reply_to, 'reply_to': reply_to,
@@ -236,15 +236,15 @@ class ServiceAPIClient(NotifyAdminAPIClient):
data data
) )
@cache.delete('service-{service_id}-templates') # @cache.delete('service-{service_id}-templates')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def update_service_template_postage(self, service_id, template_id, postage): def update_service_template_postage(self, service_id, template_id, postage):
return self.post( return self.post(
"/service/{0}/template/{1}".format(service_id, template_id), "/service/{0}/template/{1}".format(service_id, template_id),
_attach_current_user({'postage': postage}) _attach_current_user({'postage': postage})
) )
@cache.set('service-{service_id}-template-{template_id}-version-{version}') # @cache.set('service-{service_id}-template-{template_id}-version-{version}')
def get_service_template(self, service_id, template_id, version=None): def get_service_template(self, service_id, template_id, version=None):
""" """
Retrieve a service template. Retrieve a service template.
@@ -256,7 +256,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
endpoint = '{base}/version/{version}'.format(base=endpoint, version=version) endpoint = '{base}/version/{version}'.format(base=endpoint, version=version)
return self.get(endpoint) return self.get(endpoint)
@cache.set('service-{service_id}-template-{template_id}-versions') # @cache.set('service-{service_id}-template-{template_id}-versions')
def get_service_template_versions(self, service_id, template_id): def get_service_template_versions(self, service_id, template_id):
""" """
Retrieve a list of versions for a template Retrieve a list of versions for a template
@@ -273,7 +273,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
""" """
return self.get('/service/{}/template/precompiled'.format(service_id)) return self.get('/service/{}/template/precompiled'.format(service_id))
@cache.set('service-{service_id}-templates') # @cache.set('service-{service_id}-templates')
def get_service_templates(self, service_id): def get_service_templates(self, service_id):
""" """
Retrieve all templates for service. Retrieve all templates for service.
@@ -293,8 +293,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
) )
]) ])
@cache.delete('service-{service_id}-templates') # @cache.delete('service-{service_id}-templates')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def delete_service_template(self, service_id, template_id): def delete_service_template(self, service_id, template_id):
""" """
Set a service template's archived flag to True Set a service template's archived flag to True
@@ -322,7 +322,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
def get_guest_list(self, service_id): def get_guest_list(self, service_id):
return self.get(url='/service/{}/guest-list'.format(service_id)) return self.get(url='/service/{}/guest-list'.format(service_id))
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def update_guest_list(self, service_id, data): def update_guest_list(self, service_id, data):
return self.put(url='/service/{}/guest-list'.format(service_id), data=data) return self.put(url='/service/{}/guest-list'.format(service_id), data=data)
@@ -358,7 +358,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
'/service/{}/inbound-sms/summary'.format(service_id) '/service/{}/inbound-sms/summary'.format(service_id)
) )
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def create_service_inbound_api(self, service_id, url, bearer_token, user_id): def create_service_inbound_api(self, service_id, url, bearer_token, user_id):
data = { data = {
"url": url, "url": url,
@@ -367,7 +367,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
} }
return self.post("/service/{}/inbound-api".format(service_id), data) return self.post("/service/{}/inbound-api".format(service_id), data)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def update_service_inbound_api(self, service_id, url, bearer_token, user_id, inbound_api_id): def update_service_inbound_api(self, service_id, url, bearer_token, user_id, inbound_api_id):
data = { data = {
"url": url, "url": url,
@@ -384,7 +384,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
) )
)['data'] )['data']
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def delete_service_inbound_api(self, service_id, callback_api_id): def delete_service_inbound_api(self, service_id, callback_api_id):
return self.delete("/service/{}/inbound-api/{}".format( return self.delete("/service/{}/inbound-api/{}".format(
service_id, callback_api_id service_id, callback_api_id
@@ -411,8 +411,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
data={"email": email_address} data={"email": email_address}
) )
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def add_reply_to_email_address(self, service_id, email_address, is_default=False): def add_reply_to_email_address(self, service_id, email_address, is_default=False):
return self.post( return self.post(
"/service/{}/email-reply-to".format(service_id), "/service/{}/email-reply-to".format(service_id),
@@ -422,8 +422,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
} }
) )
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def update_reply_to_email_address(self, service_id, reply_to_email_id, email_address, is_default=False): def update_reply_to_email_address(self, service_id, reply_to_email_id, email_address, is_default=False):
return self.post( return self.post(
"/service/{}/email-reply-to/{}".format( "/service/{}/email-reply-to/{}".format(
@@ -436,8 +436,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
} }
) )
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def delete_reply_to_email_address(self, service_id, reply_to_email_id): def delete_reply_to_email_address(self, service_id, reply_to_email_id):
return self.post( return self.post(
"/service/{}/email-reply-to/{}/archive".format(service_id, reply_to_email_id), "/service/{}/email-reply-to/{}/archive".format(service_id, reply_to_email_id),
@@ -450,8 +450,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
def get_letter_contact(self, service_id, letter_contact_id): def get_letter_contact(self, service_id, letter_contact_id):
return self.get("/service/{}/letter-contact/{}".format(service_id, letter_contact_id)) return self.get("/service/{}/letter-contact/{}".format(service_id, letter_contact_id))
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def add_letter_contact(self, service_id, contact_block, is_default=False): def add_letter_contact(self, service_id, contact_block, is_default=False):
return self.post( return self.post(
"/service/{}/letter-contact".format(service_id), "/service/{}/letter-contact".format(service_id),
@@ -461,8 +461,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
} }
) )
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def update_letter_contact(self, service_id, letter_contact_id, contact_block, is_default=False): def update_letter_contact(self, service_id, letter_contact_id, contact_block, is_default=False):
return self.post( return self.post(
"/service/{}/letter-contact/{}".format( "/service/{}/letter-contact/{}".format(
@@ -475,8 +475,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
} }
) )
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def delete_letter_contact(self, service_id, letter_contact_id): def delete_letter_contact(self, service_id, letter_contact_id):
return self.post( return self.post(
"/service/{}/letter-contact/{}/archive".format(service_id, letter_contact_id), "/service/{}/letter-contact/{}/archive".format(service_id, letter_contact_id),
@@ -493,8 +493,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
"/service/{}/sms-sender/{}".format(service_id, sms_sender_id) "/service/{}/sms-sender/{}".format(service_id, sms_sender_id)
) )
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def add_sms_sender(self, service_id, sms_sender, is_default=False, inbound_number_id=None): def add_sms_sender(self, service_id, sms_sender, is_default=False, inbound_number_id=None):
data = { data = {
"sms_sender": sms_sender, "sms_sender": sms_sender,
@@ -504,8 +504,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
data["inbound_number_id"] = inbound_number_id data["inbound_number_id"] = inbound_number_id
return self.post("/service/{}/sms-sender".format(service_id), data=data) return self.post("/service/{}/sms-sender".format(service_id), data=data)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def update_sms_sender(self, service_id, sms_sender_id, sms_sender, is_default=False): def update_sms_sender(self, service_id, sms_sender_id, sms_sender, is_default=False):
return self.post( return self.post(
"/service/{}/sms-sender/{}".format(service_id, sms_sender_id), "/service/{}/sms-sender/{}".format(service_id, sms_sender_id),
@@ -515,8 +515,8 @@ class ServiceAPIClient(NotifyAdminAPIClient):
} }
) )
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete_by_pattern('service-{service_id}-template-*') # @cache.delete_by_pattern('service-{service_id}-template-*')
def delete_sms_sender(self, service_id, sms_sender_id): def delete_sms_sender(self, service_id, sms_sender_id):
return self.post( return self.post(
"/service/{}/sms-sender/{}/archive".format(service_id, sms_sender_id), "/service/{}/sms-sender/{}/archive".format(service_id, sms_sender_id),
@@ -530,7 +530,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
) )
)['data'] )['data']
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def update_service_callback_api(self, service_id, url, bearer_token, user_id, callback_api_id): def update_service_callback_api(self, service_id, url, bearer_token, user_id, callback_api_id):
data = { data = {
"url": url, "url": url,
@@ -540,13 +540,13 @@ class ServiceAPIClient(NotifyAdminAPIClient):
data['bearer_token'] = bearer_token data['bearer_token'] = bearer_token
return self.post("/service/{}/delivery-receipt-api/{}".format(service_id, callback_api_id), data) return self.post("/service/{}/delivery-receipt-api/{}".format(service_id, callback_api_id), data)
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def delete_service_callback_api(self, service_id, callback_api_id): def delete_service_callback_api(self, service_id, callback_api_id):
return self.delete("/service/{}/delivery-receipt-api/{}".format( return self.delete("/service/{}/delivery-receipt-api/{}".format(
service_id, callback_api_id service_id, callback_api_id
)) ))
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def create_service_callback_api(self, service_id, url, bearer_token, user_id): def create_service_callback_api(self, service_id, url, bearer_token, user_id):
data = { data = {
"url": url, "url": url,
@@ -555,7 +555,7 @@ class ServiceAPIClient(NotifyAdminAPIClient):
} }
return self.post("/service/{}/delivery-receipt-api".format(service_id), data) return self.post("/service/{}/delivery-receipt-api".format(service_id), data)
@cache.delete('service-{service_id}-data-retention') # @cache.delete('service-{service_id}-data-retention')
def create_service_data_retention(self, service_id, notification_type, days_of_retention): def create_service_data_retention(self, service_id, notification_type, days_of_retention):
data = { data = {
"notification_type": notification_type, "notification_type": notification_type,
@@ -564,29 +564,29 @@ class ServiceAPIClient(NotifyAdminAPIClient):
return self.post("/service/{}/data-retention".format(service_id), data) return self.post("/service/{}/data-retention".format(service_id), data)
@cache.delete('service-{service_id}-data-retention') # @cache.delete('service-{service_id}-data-retention')
def update_service_data_retention(self, service_id, data_retention_id, days_of_retention): def update_service_data_retention(self, service_id, data_retention_id, days_of_retention):
data = { data = {
"days_of_retention": days_of_retention "days_of_retention": days_of_retention
} }
return self.post("/service/{}/data-retention/{}".format(service_id, data_retention_id), data) return self.post("/service/{}/data-retention/{}".format(service_id, data_retention_id), data)
@cache.set('service-{service_id}-data-retention') # @cache.set('service-{service_id}-data-retention')
def get_service_data_retention(self, service_id): def get_service_data_retention(self, service_id):
return self.get("/service/{}/data-retention".format(service_id)) return self.get("/service/{}/data-retention".format(service_id))
@cache.set('service-{service_id}-returned-letters-statistics') # @cache.set('service-{service_id}-returned-letters-statistics')
def get_returned_letter_statistics(self, service_id): def get_returned_letter_statistics(self, service_id):
return self.get("service/{}/returned-letter-statistics".format(service_id)) return self.get("service/{}/returned-letter-statistics".format(service_id))
@cache.set('service-{service_id}-returned-letters-summary') # @cache.set('service-{service_id}-returned-letters-summary')
def get_returned_letter_summary(self, service_id): def get_returned_letter_summary(self, service_id):
return self.get("service/{}/returned-letter-summary".format(service_id)) return self.get("service/{}/returned-letter-summary".format(service_id))
def get_returned_letters(self, service_id, reported_at): def get_returned_letters(self, service_id, reported_at):
return self.get("service/{}/returned-letters?reported_at={}".format(service_id, reported_at)) return self.get("service/{}/returned-letters?reported_at={}".format(service_id, reported_at))
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
def set_service_broadcast_settings( def set_service_broadcast_settings(
self, service_id, service_mode, broadcast_channel, provider_restriction, cached_service_user_ids self, service_id, service_mode, broadcast_channel, provider_restriction, cached_service_user_ids
): ):

2
app/notify_client/status_api_client.py
View File

@@ -6,7 +6,7 @@ class StatusApiClient(NotifyAdminAPIClient):
def get_status(self, *params): def get_status(self, *params):
return self.get(url='/_status', *params) return self.get(url='/_status', *params)
@cache.set('live-service-and-organisation-counts', ttl_in_seconds=3600) # @cache.set('live-service-and-organisation-counts', ttl_in_seconds=3600)
def get_count_of_live_services_and_organisations(self): def get_count_of_live_services_and_organisations(self):
return self.get(url='/_status/live-service-and-organisation-counts') return self.get(url='/_status/live-service-and-organisation-counts')

12
app/notify_client/template_folder_api_client.py
View File

@@ -4,7 +4,7 @@ from app.notify_client import NotifyAdminAPIClient, cache
class TemplateFolderAPIClient(NotifyAdminAPIClient): class TemplateFolderAPIClient(NotifyAdminAPIClient):
@cache.delete('service-{service_id}-template-folders') # @cache.delete('service-{service_id}-template-folders')
def create_template_folder( def create_template_folder(
self, self,
service_id, service_id,
@@ -17,7 +17,7 @@ class TemplateFolderAPIClient(NotifyAdminAPIClient):
} }
return self.post('/service/{}/template-folder'.format(service_id), data)['data']['id'] return self.post('/service/{}/template-folder'.format(service_id), data)['data']['id']
@cache.set('service-{service_id}-template-folders') # @cache.set('service-{service_id}-template-folders')
def get_template_folders(self, service_id): def get_template_folders(self, service_id):
return self.get('/service/{}/template-folder'.format(service_id))['template_folders'] return self.get('/service/{}/template-folder'.format(service_id))['template_folders']
@@ -34,8 +34,8 @@ class TemplateFolderAPIClient(NotifyAdminAPIClient):
if folder['id'] == str(folder_id) if folder['id'] == str(folder_id)
) )
@cache.delete('service-{service_id}-template-folders') # @cache.delete('service-{service_id}-template-folders')
@cache.delete('service-{service_id}-templates') # @cache.delete('service-{service_id}-templates')
def move_to_folder(self, service_id, folder_id, template_ids, folder_ids): def move_to_folder(self, service_id, folder_id, template_ids, folder_ids):
if folder_id: if folder_id:
@@ -51,7 +51,7 @@ class TemplateFolderAPIClient(NotifyAdminAPIClient):
if template_ids: if template_ids:
redis_client.delete(*(f'service-{service_id}-template-{id}-version-None' for id in template_ids)) redis_client.delete(*(f'service-{service_id}-template-{id}-version-None' for id in template_ids))
@cache.delete('service-{service_id}-template-folders') # @cache.delete('service-{service_id}-template-folders')
def update_template_folder(self, service_id, template_folder_id, name, users_with_permission=None): def update_template_folder(self, service_id, template_folder_id, name, users_with_permission=None):
data = {"name": name} data = {"name": name}
if users_with_permission: if users_with_permission:
@@ -61,7 +61,7 @@ class TemplateFolderAPIClient(NotifyAdminAPIClient):
data data
) )
@cache.delete('service-{service_id}-template-folders') # @cache.delete('service-{service_id}-template-folders')
def delete_template_folder(self, service_id, template_folder_id): def delete_template_folder(self, service_id, template_folder_id):
self.delete('/service/{}/template-folder/{}'.format(service_id, template_folder_id), {}) self.delete('/service/{}/template-folder/{}'.format(service_id, template_folder_id), {})

30
app/notify_client/user_api_client.py
View File

@@ -34,7 +34,7 @@ class UserApiClient(NotifyAdminAPIClient):
def get_user(self, user_id): def get_user(self, user_id):
return self._get_user(user_id)['data'] return self._get_user(user_id)['data']
@cache.set('user-{user_id}') # @cache.set('user-{user_id}')
def _get_user(self, user_id): def _get_user(self, user_id):
return self.get("/user/{}".format(user_id)) return self.get("/user/{}".format(user_id))
@@ -50,7 +50,7 @@ class UserApiClient(NotifyAdminAPIClient):
return None return None
raise e raise e
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def update_user_attribute(self, user_id, **kwargs): def update_user_attribute(self, user_id, **kwargs):
data = dict(kwargs) data = dict(kwargs)
disallowed_attributes = set(data.keys()) - ALLOWED_ATTRIBUTES disallowed_attributes = set(data.keys()) - ALLOWED_ATTRIBUTES
@@ -63,24 +63,24 @@ class UserApiClient(NotifyAdminAPIClient):
user_data = self.post(url, data=data) user_data = self.post(url, data=data)
return user_data['data'] return user_data['data']
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def archive_user(self, user_id): def archive_user(self, user_id):
return self.post('/user/{}/archive'.format(user_id), data=None) return self.post('/user/{}/archive'.format(user_id), data=None)
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def reset_failed_login_count(self, user_id): def reset_failed_login_count(self, user_id):
url = "/user/{}/reset-failed-login-count".format(user_id) url = "/user/{}/reset-failed-login-count".format(user_id)
user_data = self.post(url, data={}) user_data = self.post(url, data={})
return user_data['data'] return user_data['data']
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def update_password(self, user_id, password): def update_password(self, user_id, password):
data = {"_password": password} data = {"_password": password}
url = "/user/{}/update-password".format(user_id) url = "/user/{}/update-password".format(user_id)
user_data = self.post(url, data=data) user_data = self.post(url, data=data)
return user_data['data'] return user_data['data']
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def verify_password(self, user_id, password): def verify_password(self, user_id, password):
try: try:
url = "/user/{}/verify/password".format(user_id) url = "/user/{}/verify/password".format(user_id)
@@ -113,7 +113,7 @@ class UserApiClient(NotifyAdminAPIClient):
endpoint = '/user/{0}/email-already-registered'.format(user_id) endpoint = '/user/{0}/email-already-registered'.format(user_id)
self.post(endpoint, data=data) self.post(endpoint, data=data)
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def check_verify_code(self, user_id, code, code_type): def check_verify_code(self, user_id, code, code_type):
data = {'code_type': code_type, 'code': code} data = {'code_type': code_type, 'code': code}
endpoint = '/user/{}/verify/code'.format(user_id) endpoint = '/user/{}/verify/code'.format(user_id)
@@ -125,7 +125,7 @@ class UserApiClient(NotifyAdminAPIClient):
return False, e.message return False, e.message
raise e raise e
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def complete_webauthn_login_attempt(self, user_id, is_successful): def complete_webauthn_login_attempt(self, user_id, is_successful):
data = {'successful': is_successful} data = {'successful': is_successful}
endpoint = f'/user/{user_id}/complete/webauthn-login' endpoint = f'/user/{user_id}/complete/webauthn-login'
@@ -145,9 +145,9 @@ class UserApiClient(NotifyAdminAPIClient):
endpoint = '/organisations/{}/users'.format(org_id) endpoint = '/organisations/{}/users'.format(org_id)
return self.get(endpoint)['data'] return self.get(endpoint)['data']
@cache.delete('service-{service_id}') # @cache.delete('service-{service_id}')
@cache.delete('service-{service_id}-template-folders') # @cache.delete('service-{service_id}-template-folders')
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def add_user_to_service(self, service_id, user_id, permissions, folder_permissions): def add_user_to_service(self, service_id, user_id, permissions, folder_permissions):
# permissions passed in are the combined UI permissions, not DB permissions # permissions passed in are the combined UI permissions, not DB permissions
endpoint = '/service/{}/users/{}'.format(service_id, user_id) endpoint = '/service/{}/users/{}'.format(service_id, user_id)
@@ -158,13 +158,13 @@ class UserApiClient(NotifyAdminAPIClient):
self.post(endpoint, data=data) self.post(endpoint, data=data)
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def add_user_to_organisation(self, org_id, user_id): def add_user_to_organisation(self, org_id, user_id):
resp = self.post('/organisations/{}/users/{}'.format(org_id, user_id), data={}) resp = self.post('/organisations/{}/users/{}'.format(org_id, user_id), data={})
return resp['data'] return resp['data']
@cache.delete('service-{service_id}-template-folders') # @cache.delete('service-{service_id}-template-folders')
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def set_user_permissions(self, user_id, service_id, permissions, folder_permissions=None): def set_user_permissions(self, user_id, service_id, permissions, folder_permissions=None):
# permissions passed in are the combined UI permissions, not DB permissions # permissions passed in are the combined UI permissions, not DB permissions
data = { data = {
@@ -193,7 +193,7 @@ class UserApiClient(NotifyAdminAPIClient):
users = self.post(endpoint, data=data) users = self.post(endpoint, data=data)
return users return users
@cache.delete('user-{user_id}') # @cache.delete('user-{user_id}')
def activate_user(self, user_id): def activate_user(self, user_id):
return self.post("/user/{}/activate".format(user_id), data=None) return self.post("/user/{}/activate".format(user_id), data=None)

12
application.log.json Normal file
View File

@@ -0,0 +1,12 @@
Logging configured
Logging configured
Logging configured
Logging configured again
Logging configured
Logging configured again
Logging configured
Logging configured again
Logging configured
Logging configured again
Logging configured
Logging configured again