darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-08-23 15:56:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #991 from alphagov/invite-service-to-schedule

Browse Source 
Invite the service to schedule notifications from the API
This commit is contained in:
Rebecca Law
2017-06-01 12:37:32 +01:00
committed by GitHub
parent 0141e53c7a e3baf71016
commit 40aadf2748
6 changed files with 51 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
app/models.py
View File

@@ -146,8 +146,10 @@ class DVLAOrganisation(db.Model):
INTERNATIONAL_SMS_TYPE = 'international_sms' INTERNATIONAL_SMS_TYPE = 'international_sms'
INBOUND_SMS_TYPE = 'inbound_sms' INBOUND_SMS_TYPE = 'inbound_sms'
SCHEDULE_NOTIFICATIONS = 'schedule_notifications'
SERVICE_PERMISSION_TYPES = [EMAIL_TYPE, SMS_TYPE, LETTER_TYPE, INTERNATIONAL_SMS_TYPE, INBOUND_SMS_TYPE] SERVICE_PERMISSION_TYPES = [EMAIL_TYPE, SMS_TYPE, LETTER_TYPE, INTERNATIONAL_SMS_TYPE, INBOUND_SMS_TYPE,
SCHEDULE_NOTIFICATIONS]
class ServicePermissionTypes(db.Model): class ServicePermissionTypes(db.Model):
@@ -977,7 +979,7 @@ INVITED_USER_STATUS_TYPES = ['pending', 'accepted', 'cancelled']
class ScheduledNotification(db.Model): class ScheduledNotification(db.Model):
__tablename__ = 'scheduled_notifications' __tablename__ = 'scheduled_notifications'
id = db.Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4()) id = db.Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
notification_id = db.Column(UUID(as_uuid=True), db.ForeignKey('notifications.id'), index=True, nullable=False) notification_id = db.Column(UUID(as_uuid=True), db.ForeignKey('notifications.id'), index=True, nullable=False)
notification = db.relationship('Notification', uselist=False) notification = db.relationship('Notification', uselist=False)
scheduled_for = db.Column(db.DateTime, index=False, nullable=False) scheduled_for = db.Column(db.DateTime, index=False, nullable=False)

9
app/notifications/validators.py
View File

@@ -6,7 +6,7 @@ from notifications_utils.recipients import (
) )
from app.dao import services_dao from app.dao import services_dao
from app.models import KEY_TYPE_TEST, KEY_TYPE_TEAM, SMS_TYPE from app.models import KEY_TYPE_TEST, KEY_TYPE_TEAM, SMS_TYPE, SCHEDULE_NOTIFICATIONS
from app.service.utils import service_allowed_to_send_to from app.service.utils import service_allowed_to_send_to
from app.v2.errors import TooManyRequestsError, BadRequestError, RateLimitError from app.v2.errors import TooManyRequestsError, BadRequestError, RateLimitError
from app import redis_store from app import redis_store
@@ -92,6 +92,7 @@ def check_sms_content_char_count(content_count):
raise BadRequestError(message=message) raise BadRequestError(message=message)
def service_can_schedule_notification(service): def service_can_schedule_notification(service, scheduled_for):
# TODO: implement once the service permission works. if scheduled_for:
raise BadRequestError(message="Your service must be invited to schedule notifications via the API.") if SCHEDULE_NOTIFICATIONS not in [p.permission for p in service.permissions]:
raise BadRequestError(message="Cannot schedule notifications (this feature is invite-only)")

8
app/v2/notifications/notification_schemas.py
View File

@@ -113,7 +113,7 @@ post_sms_request = {
"phone_number": {"type": "string", "format": "phone_number"}, "phone_number": {"type": "string", "format": "phone_number"},
"template_id": uuid, "template_id": uuid,
"personalisation": personalisation, "personalisation": personalisation,
"scheduled_for": {"type": "string", "format": "datetime"} "scheduled_for": {"type": ["string", "null"], "format": "datetime"}
}, },
"required": ["phone_number", "template_id"] "required": ["phone_number", "template_id"]
} }
@@ -141,7 +141,7 @@ post_sms_response = {
"content": sms_content, "content": sms_content,
"uri": {"type": "string", "format": "uri"}, "uri": {"type": "string", "format": "uri"},
"template": template, "template": template,
"scheduled_for": {"type": "string"} "scheduled_for": {"type": ["string", "null"]}
}, },
"required": ["id", "content", "uri", "template"] "required": ["id", "content", "uri", "template"]
} }
@@ -157,7 +157,7 @@ post_email_request = {
"email_address": {"type": "string", "format": "email_address"}, "email_address": {"type": "string", "format": "email_address"},
"template_id": uuid, "template_id": uuid,
"personalisation": personalisation, "personalisation": personalisation,
"scheduled_for": {"type": "string", "format": "datetime"} "scheduled_for": {"type": ["string", "null"], "format": "datetime"}
}, },
"required": ["email_address", "template_id"] "required": ["email_address", "template_id"]
} }
@@ -186,7 +186,7 @@ post_email_response = {
"content": email_content, "content": email_content,
"uri": {"type": "string", "format": "uri"}, "uri": {"type": "string", "format": "uri"},
"template": template, "template": template,
"scheduled_for": {"type": "string"} "scheduled_for": {"type": ["string", "null"]}
}, },
"required": ["id", "content", "uri", "template"] "required": ["id", "content", "uri", "template"]
} }

5
app/v2/notifications/post_notifications.py
View File

@@ -35,9 +35,8 @@ def post_notification(notification_type):
form = validate(request.get_json(), post_sms_request) form = validate(request.get_json(), post_sms_request)
scheduled_for = form.get("scheduled_for", None) scheduled_for = form.get("scheduled_for", None)
if scheduled_for: service_can_schedule_notification(authenticated_service, scheduled_for)
if not service_can_schedule_notification(authenticated_service):
return
check_rate_limiting(authenticated_service, api_user) check_rate_limiting(authenticated_service, api_user)
form_send_to = form['phone_number'] if notification_type == SMS_TYPE else form['email_address'] form_send_to = form['phone_number'] if notification_type == SMS_TYPE else form['email_address']

24
migrations/versions/0088_add_schedule_serv_perm.py Normal file
View File

@@ -0,0 +1,24 @@
"""empty message
Revision ID: 0088_add_schedule_serv_perm
Revises: 0087_scheduled_notifications
Create Date: 2017-05-26 14:53:18.581320
"""
# revision identifiers, used by Alembic.
revision = '0088_add_schedule_serv_perm'
down_revision = '0087_scheduled_notifications'
from alembic import op
def upgrade():
op.get_bind()
op.execute("insert into service_permission_types values('schedule_notifications')")
def downgrade():
op.get_bind()
op.execute("delete from service_permissions where permission = 'schedule_notifications'")
op.execute("delete from service_permission_types where name = 'schedule_notifications'")

21
tests/app/v2/notifications/test_post_notifications.py
View File

@@ -3,13 +3,14 @@ import uuid
import pytest import pytest
from freezegun import freeze_time from freezegun import freeze_time
from app.models import Notification, ScheduledNotification from app.models import Notification, ScheduledNotification, SCHEDULE_NOTIFICATIONS, EMAIL_TYPE, SMS_TYPE
from flask import json, current_app from flask import json, current_app
from app.models import Notification from app.models import Notification
from app.v2.errors import RateLimitError from app.v2.errors import RateLimitError
from tests import create_authorization_header from tests import create_authorization_header
from tests.app.conftest import sample_template as create_sample_template, sample_service from tests.app.conftest import sample_template as create_sample_template, sample_service
from tests.app.db import create_service, create_template
@pytest.mark.parametrize("reference", [None, "reference_from_client"]) @pytest.mark.parametrize("reference", [None, "reference_from_client"])
@@ -350,26 +351,28 @@ def test_post_sms_should_persist_supplied_sms_number(client, sample_template_wit
assert mocked.called assert mocked.called
@pytest.mark.skip("Once the service can be invited to schedule notifications we can add this test.")
@pytest.mark.parametrize("notification_type, key_send_to, send_to", @pytest.mark.parametrize("notification_type, key_send_to, send_to",
[("sms", "phone_number", "07700 900 855"), [("sms", "phone_number", "07700 900 855"),
("email", "email_address", "sample@email.com")]) ("email", "email_address", "sample@email.com")])
@freeze_time("2017-05-14 14:00:00") @freeze_time("2017-05-14 14:00:00")
def test_post_notification_with_scheduled_for(client, sample_template, sample_email_template, def test_post_notification_with_scheduled_for(client, notify_db, notify_db_session,
notification_type, key_send_to, send_to): notification_type, key_send_to, send_to):
service = create_service(service_name=str(uuid.uuid4()),
service_permissions=[EMAIL_TYPE, SMS_TYPE, SCHEDULE_NOTIFICATIONS])
template = create_template(service=service, template_type=notification_type)
data = { data = {
key_send_to: send_to, key_send_to: send_to,
'template_id': str(sample_email_template.id) if notification_type == 'email' else str(sample_template.id), 'template_id': str(template.id) if notification_type == 'email' else str(template.id),
'scheduled_for': '2017-05-14 14:15' 'scheduled_for': '2017-05-14 14:15'
} }
auth_header = create_authorization_header(service_id=sample_template.service_id) auth_header = create_authorization_header(service_id=service.id)
response = client.post('/v2/notifications/{}'.format(notification_type), response = client.post('/v2/notifications/{}'.format(notification_type),
data=json.dumps(data), data=json.dumps(data),
headers=[('Content-Type', 'application/json'), auth_header]) headers=[('Content-Type', 'application/json'), auth_header])
assert response.status_code == 201 assert response.status_code == 201
resp_json = json.loads(response.get_data(as_text=True)) resp_json = json.loads(response.get_data(as_text=True))
scheduled_notification = ScheduledNotification.query.all() scheduled_notification = ScheduledNotification.query.filter_by(notification_id=resp_json["id"]).all()
assert len(scheduled_notification) == 1 assert len(scheduled_notification) == 1
assert resp_json["id"] == str(scheduled_notification[0].notification_id) assert resp_json["id"] == str(scheduled_notification[0].notification_id)
assert resp_json["scheduled_for"] == '2017-05-14 14:15' assert resp_json["scheduled_for"] == '2017-05-14 14:15'
@@ -379,8 +382,8 @@ def test_post_notification_with_scheduled_for(client, sample_template, sample_em
[("sms", "phone_number", "07700 900 855"), [("sms", "phone_number", "07700 900 855"),
("email", "email_address", "sample@email.com")]) ("email", "email_address", "sample@email.com")])
@freeze_time("2017-05-14 14:00:00") @freeze_time("2017-05-14 14:00:00")
def test_post_notification_with_scheduled_for_raises_bad_request(client, sample_template, sample_email_template, def test_post_notification_raises_bad_request_if_service_not_invited_to_schedule(
notification_type, key_send_to, send_to): client, sample_template, sample_email_template, notification_type, key_send_to, send_to):
data = { data = {
key_send_to: send_to, key_send_to: send_to,
'template_id': str(sample_email_template.id) if notification_type == 'email' else str(sample_template.id), 'template_id': str(sample_email_template.id) if notification_type == 'email' else str(sample_template.id),
@@ -394,4 +397,4 @@ def test_post_notification_with_scheduled_for_raises_bad_request(client, sample_
assert response.status_code == 400 assert response.status_code == 400
error_json = json.loads(response.get_data(as_text=True)) error_json = json.loads(response.get_data(as_text=True))
assert error_json['errors'] == [ assert error_json['errors'] == [
{"error": "BadRequestError", "message": 'Your service must be invited to schedule notifications via the API.'}] {"error": "BadRequestError", "message": 'Cannot schedule notifications (this feature is invite-only)'}]