from __future__ import unicode_literals from flask import url_for from notifications_python_client.base import BaseAPIClient from app.utils import BrowsableItem from app.notify_client import _attach_current_user class ServiceAPIClient(BaseAPIClient): # Fudge assert in the super __init__ so # we can set those variables later. def __init__(self): super().__init__("a", "b", "c") def init_app(self, application): self.base_url = application.config['API_HOST_NAME'] self.service_id = application.config['ADMIN_CLIENT_USER_NAME'] self.api_key = application.config['ADMIN_CLIENT_SECRET'] def create_service(self, service_name, active, message_limit, restricted, user_id, email_from): """ Create a service and return the json. """ data = { "name": service_name, "active": active, "message_limit": message_limit, "user_id": user_id, "restricted": restricted, "email_from": email_from } data = _attach_current_user(data) return self.post("/service", data)['data']['id'] def get_service(self, service_id): return self._get_service(service_id, detailed=False, today_only=False) def get_detailed_service(self, service_id): return self._get_service(service_id, detailed=True, today_only=False) def get_detailed_service_for_today(self, service_id): return self._get_service(service_id, detailed=True, today_only=True) def _get_service(self, service_id, detailed, today_only): """ Retrieve a service. :param detailed - return additional details, including notification statistics :param today_only - return statistics only for today. No effect if detailed not passed in """ params = {} if detailed: params['detailed'] = detailed if today_only: params['today_only'] = today_only return self.get( '/service/{0}'.format(service_id), params=params) def get_services(self, *params): """ Retrieve a list of services. """ return self.get('/service', *params) def update_service( self, service_id, **kwargs ): """ Update a service. """ data = _attach_current_user(kwargs) disallowed_attributes = set(data.keys()) - { 'name', 'message_limit', 'active', 'restricted', 'email_from', 'reply_to_email_address', 'research_mode', 'can_send_letters', 'sms_sender', 'created_by', 'branding', 'organisation' } if disallowed_attributes: raise TypeError('Not allowed to update service attributes: {}'.format( ", ".join(disallowed_attributes) )) endpoint = "/service/{0}".format(service_id) return self.post(endpoint, data) def update_service_with_properties(self, service_id, properties): return self.update_service(service_id, **properties) def deactivate_service(self, service_id): return self.post('/service/{}/deactivate'.format(service_id), data=None) def remove_user_from_service(self, service_id, user_id): """ Remove a user from a service """ endpoint = '/service/{service_id}/users/{user_id}'.format( service_id=service_id, user_id=user_id) data = _attach_current_user({}) return self.delete(endpoint, data) def create_service_template(self, name, type_, content, service_id, subject=None): """ Create a service template. """ data = { "name": name, "template_type": type_, "content": content, "service": service_id } if subject: data.update({ 'subject': subject }) data = _attach_current_user(data) endpoint = "/service/{0}/template".format(service_id) return self.post(endpoint, data) def update_service_template(self, id_, name, type_, content, service_id, subject=None): """ Update a service template. """ data = { 'id': id_, 'name': name, 'template_type': type_, 'content': content, 'service': service_id } if subject: data.update({ 'subject': subject }) data = _attach_current_user(data) endpoint = "/service/{0}/template/{1}".format(service_id, id_) return self.post(endpoint, data) def get_service_template(self, service_id, template_id, version=None, *params): """ Retrieve a service template. """ endpoint = '/service/{service_id}/template/{template_id}'.format( service_id=service_id, template_id=template_id) if version: endpoint = '{base}/version/{version}'.format(base=endpoint, version=version) return self.get(endpoint, *params) def get_service_template_versions(self, service_id, template_id, *params): """ Retrieve a list of versions for a template """ endpoint = '/service/{service_id}/template/{template_id}/versions'.format( service_id=service_id, template_id=template_id ) return self.get(endpoint, *params) def get_service_templates(self, service_id, *params): """ Retrieve all templates for service. """ endpoint = '/service/{service_id}/template'.format( service_id=service_id) return self.get(endpoint, *params) def delete_service_template(self, service_id, template_id): """ Set a service template's archived flag to True """ endpoint = "/service/{0}/template/{1}".format(service_id, template_id) data = { 'archived': True } data = _attach_current_user(data) return self.post(endpoint, data=data) def find_all_service_email_from(self, user_id=None): resp = self.get_services(user_id) return [x['email_from'] for x in resp['data']] # Temp access of service history data. Includes service and api key history def get_service_history(self, service_id): return self.get('/service/{0}/history'.format(service_id)) def get_service_usage(self, service_id): return self.get('/service/{0}/fragment/aggregate_statistics'.format(service_id)) def get_weekly_notification_stats(self, service_id): return self.get(url='/service/{}/notifications/weekly'.format(service_id)) def get_whitelist(self, service_id): return self.get(url='/service/{}/whitelist'.format(service_id)) def update_whitelist(self, service_id, data): return self.put(url='/service/{}/whitelist'.format(service_id), data=data) def get_billable_units(self, service_id, year): return self.get(url='/service/{}/billable-units?year={}'.format(service_id, year)) class ServicesBrowsableItem(BrowsableItem): @property def title(self): return self._item['name'] @property def link(self): return url_for('main.service_dashboard', service_id=self._item['id']) @property def destructive(self): return False @property def hint(self): return None