mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-04-06 18:41:25 -04:00
dda37b6538
During the migration from the model inhereting from a `dict` to being a plain object it was useful to have these exceptions raised for quicker debugging. Now that all the code which relied on these methods has gone it’s OK to remove them (attempts to call them will fall through to Python’s native exception handling).
255 lines
7.4 KiB
Python
255 lines
7.4 KiB
Python
from notifications_utils.field import Field
|
|
from werkzeug.utils import cached_property
|
|
|
|
from app.notify_client.billing_api_client import billing_api_client
|
|
from app.notify_client.email_branding_client import email_branding_client
|
|
from app.notify_client.inbound_number_client import inbound_number_client
|
|
from app.notify_client.job_api_client import job_api_client
|
|
from app.notify_client.organisations_api_client import organisations_client
|
|
from app.notify_client.service_api_client import service_api_client
|
|
from app.notify_client.user_api_client import user_api_client
|
|
from app.utils import get_default_sms_sender
|
|
|
|
|
|
class Service():
|
|
|
|
ALLOWED_PROPERTIES = {
|
|
'active',
|
|
'contact_link',
|
|
'dvla_organisation',
|
|
'email_branding',
|
|
'email_from',
|
|
'id',
|
|
'inbound_api',
|
|
'letter_contact_block',
|
|
'letter_logo_filename',
|
|
'message_limit',
|
|
'name',
|
|
'organisation_type',
|
|
'permissions',
|
|
'postage',
|
|
'prefix_sms',
|
|
'research_mode',
|
|
'service_callback_api',
|
|
}
|
|
|
|
def __init__(self, _dict):
|
|
# in the case of a bad request current service may be `None`
|
|
self._dict = _dict or {}
|
|
if 'permissions' not in self._dict:
|
|
self.permissions = {'email', 'sms', 'letter'}
|
|
|
|
def __bool__(self):
|
|
return self._dict != {}
|
|
|
|
def __getattr__(self, attr):
|
|
if attr in self.ALLOWED_PROPERTIES:
|
|
return self._dict[attr]
|
|
raise AttributeError('`{}` is not a service attribute'.format(attr))
|
|
|
|
@property
|
|
def trial_mode(self):
|
|
return self._dict['restricted']
|
|
|
|
def has_permission(self, permission):
|
|
return permission in self.permissions
|
|
|
|
@cached_property
|
|
def has_jobs(self):
|
|
return job_api_client.has_jobs(self.id)
|
|
|
|
@cached_property
|
|
def has_team_members(self):
|
|
return user_api_client.get_count_of_users_with_permission(
|
|
self.id, 'manage_service'
|
|
) > 1
|
|
|
|
@cached_property
|
|
def templates(self):
|
|
|
|
templates = service_api_client.get_service_templates(self.id)['data']
|
|
|
|
return [
|
|
template for template in templates
|
|
if template['template_type'] in self.available_template_types
|
|
]
|
|
|
|
def templates_by_type(self, template_type):
|
|
if isinstance(template_type, str):
|
|
template_type = [template_type]
|
|
return [
|
|
template for template in self.templates
|
|
if set(template_type) & {'all', template['template_type']}
|
|
]
|
|
|
|
@property
|
|
def available_template_types(self):
|
|
return [
|
|
channel for channel in ('email', 'sms', 'letter')
|
|
if self.has_permission(channel)
|
|
]
|
|
|
|
@property
|
|
def has_templates(self):
|
|
return len(self.templates) > 0
|
|
|
|
@property
|
|
def has_multiple_template_types(self):
|
|
return len({
|
|
template['template_type'] for template in self.templates
|
|
}) > 1
|
|
|
|
@property
|
|
def has_email_templates(self):
|
|
return len(self.templates_by_type('email')) > 0
|
|
|
|
@property
|
|
def has_sms_templates(self):
|
|
return len(self.templates_by_type('sms')) > 0
|
|
|
|
@cached_property
|
|
def email_reply_to_addresses(self):
|
|
return service_api_client.get_reply_to_email_addresses(self.id)
|
|
|
|
@property
|
|
def has_email_reply_to_address(self):
|
|
return bool(self.email_reply_to_addresses)
|
|
|
|
@property
|
|
def count_email_reply_to_addresses(self):
|
|
return len(self.email_reply_to_addresses)
|
|
|
|
@property
|
|
def default_email_reply_to_address(self):
|
|
return next(
|
|
(
|
|
x['email_address']
|
|
for x in self.email_reply_to_addresses if x['is_default']
|
|
), None
|
|
)
|
|
|
|
def get_email_reply_to_address(self, id):
|
|
return service_api_client.get_reply_to_email_address(self.id, id)
|
|
|
|
@property
|
|
def needs_to_add_email_reply_to_address(self):
|
|
return self.has_email_templates and not self.has_email_reply_to_address
|
|
|
|
@property
|
|
def shouldnt_use_govuk_as_sms_sender(self):
|
|
return self.organisation_type in {'local', 'nhs'}
|
|
|
|
@cached_property
|
|
def sms_senders(self):
|
|
return service_api_client.get_sms_senders(self.id)
|
|
|
|
@property
|
|
def sms_senders_with_hints(self):
|
|
|
|
def attach_hint(sender):
|
|
hints = []
|
|
if sender['is_default']:
|
|
hints += ["default"]
|
|
if sender['inbound_number_id']:
|
|
hints += ["receives replies"]
|
|
if hints:
|
|
sender['hint'] = "(" + " and ".join(hints) + ")"
|
|
return sender
|
|
|
|
return [attach_hint(sender) for sender in self.sms_senders]
|
|
|
|
@property
|
|
def default_sms_sender(self):
|
|
return get_default_sms_sender(self.sms_senders)
|
|
|
|
@property
|
|
def count_sms_senders(self):
|
|
return len(self.sms_senders)
|
|
|
|
@property
|
|
def sms_sender_is_govuk(self):
|
|
return self.default_sms_sender in {'GOVUK', 'None'}
|
|
|
|
def get_sms_sender(self, id):
|
|
return service_api_client.get_sms_sender(self.id, id)
|
|
|
|
@property
|
|
def needs_to_change_sms_sender(self):
|
|
return all((
|
|
self.has_sms_templates,
|
|
self.shouldnt_use_govuk_as_sms_sender,
|
|
self.sms_sender_is_govuk,
|
|
))
|
|
|
|
@cached_property
|
|
def letter_contact_details(self):
|
|
return service_api_client.get_letter_contacts(self.id)
|
|
|
|
@property
|
|
def count_letter_contact_details(self):
|
|
return len(self.letter_contact_details)
|
|
|
|
@property
|
|
def default_letter_contact_block(self):
|
|
return next(
|
|
(
|
|
Field(x['contact_block'], html='escape')
|
|
for x in self.letter_contact_details if x['is_default']
|
|
), None
|
|
)
|
|
|
|
def get_letter_contact_block(self, id):
|
|
return service_api_client.get_letter_contact(self.id, id)
|
|
|
|
@property
|
|
def go_live_checklist_completed(self):
|
|
return all((
|
|
self.has_team_members,
|
|
self.has_templates,
|
|
not self.needs_to_add_email_reply_to_address,
|
|
not self.needs_to_change_sms_sender,
|
|
))
|
|
|
|
@property
|
|
def go_live_checklist_completed_as_yes_no(self):
|
|
return 'Yes' if self.go_live_checklist_completed else 'No'
|
|
|
|
@cached_property
|
|
def free_sms_fragment_limit(self):
|
|
return billing_api_client.get_free_sms_fragment_limit_for_year(self.id) or 0
|
|
|
|
@cached_property
|
|
def data_retention(self):
|
|
return service_api_client.get_service_data_retention(self.id)
|
|
|
|
def get_data_retention_item(self, id):
|
|
return service_api_client.get_service_data_retention_by_id(self.id, id)
|
|
|
|
@property
|
|
def email_branding_id(self):
|
|
return self._dict['email_branding']
|
|
|
|
@cached_property
|
|
def email_branding(self):
|
|
if self.email_branding_id:
|
|
return email_branding_client.get_email_branding(self.email_branding_id)['email_branding']
|
|
return None
|
|
|
|
@cached_property
|
|
def letter_branding(self):
|
|
return email_branding_client.get_letter_email_branding().get(
|
|
self.dvla_organisation, '001'
|
|
)
|
|
|
|
@cached_property
|
|
def organisation_name(self):
|
|
return organisations_client.get_service_organisation(self.id).get('name', None)
|
|
|
|
@cached_property
|
|
def inbound_number(self):
|
|
return inbound_number_client.get_inbound_sms_number_for_service(self.id)['data'].get('number', '')
|
|
|
|
@property
|
|
def has_inbound_number(self):
|
|
return bool(self.inbound_number)
|