- new endpoint to check the token for an org invitation.

- new endpoint to add user to organisation
- new endpoint to return users for an organisation
This commit is contained in:
Rebecca Law
2018-02-20 17:09:16 +00:00
parent 57a174aeb4
commit 13ef2d7bae
11 changed files with 125 additions and 17 deletions

View File

@@ -109,6 +109,7 @@ def register_blueprint(application):
from app.billing.rest import billing_blueprint from app.billing.rest import billing_blueprint
from app.organisation.rest import organisation_blueprint from app.organisation.rest import organisation_blueprint
from app.organisation.invite_rest import organisation_invite_blueprint from app.organisation.invite_rest import organisation_invite_blueprint
from app.organisation.accept_organisation_invite import accept_organisation_invite_blueprint
service_blueprint.before_request(requires_admin_auth) service_blueprint.before_request(requires_admin_auth)
application.register_blueprint(service_blueprint, url_prefix='/service') application.register_blueprint(service_blueprint, url_prefix='/service')
@@ -185,6 +186,9 @@ def register_blueprint(application):
organisation_invite_blueprint.before_request(requires_admin_auth) organisation_invite_blueprint.before_request(requires_admin_auth)
application.register_blueprint(organisation_invite_blueprint) application.register_blueprint(organisation_invite_blueprint)
accept_organisation_invite_blueprint.before_request(requires_admin_auth)
application.register_blueprint(accept_organisation_invite_blueprint)
def register_v2_blueprints(application): def register_v2_blueprints(application):
from app.v2.inbound_sms.get_inbound_sms import v2_inbound_sms_blueprint as get_inbound_sms from app.v2.inbound_sms.get_inbound_sms import v2_inbound_sms_blueprint as get_inbound_sms

View File

@@ -1,6 +1,6 @@
from app import db from app import db
from app.dao.dao_utils import transactional from app.dao.dao_utils import transactional
from app.models import Organisation from app.models import Organisation, InvitedOrganisationUser, User
def dao_get_organisations(): def dao_get_organisations():
@@ -42,3 +42,23 @@ def dao_add_service_to_organisation(service, organisation_id):
).one() ).one()
organisation.services.append(service) organisation.services.append(service)
def dao_get_invited_organisation_user(user_id):
return InvitedOrganisationUser.query.filter_by(id=user_id).first()
def dao_get_users_for_organisation(organisation_id):
return User.query.filter(
User.user_to_organisation.any(id=organisation_id),
User.state == 'active'
).all()
def dao_add_user_to_organisation(organisation_id, user_id):
organisation = dao_get_organisation_by_id(organisation_id)
user = User.query.get(user_id)
organisation.users.append(user)
db.session.add(organisation)
db.session.commit()
return user

View File

@@ -116,6 +116,10 @@ class User(db.Model):
'Service', 'Service',
secondary='user_to_service', secondary='user_to_service',
backref=db.backref('user_to_service', lazy='dynamic')) backref=db.backref('user_to_service', lazy='dynamic'))
organisations = db.relationship(
'Organisation',
secondary='user_to_organisation',
backref=db.backref('user_to_organisation', lazy='dynamic'))
@property @property
def password(self): def password(self):
@@ -245,8 +249,8 @@ class Organisation(db.Model):
users = db.relationship( users = db.relationship(
'User', 'User',
secondary='user_to_organisation', secondary=user_to_organisation,
backref=db.backref('organisations', lazy='dynamic')) backref=db.backref('user_to_organisation', lazy='dynamic'))
def serialize(self): def serialize(self):
serialized = { serialized = {
@@ -1447,10 +1451,10 @@ class InvitedOrganisationUser(db.Model):
def serialize(self): def serialize(self):
return { return {
'id': self.id, 'id': str(self.id),
'email_address': self.email_address, 'email_address': self.email_address,
'invited_by': self.invited_by_id, 'invited_by': str(self.invited_by_id),
'organisation': self.organisation_id, 'organisation': str(self.organisation_id),
'created_at': self.created_at.strftime(DATETIME_FORMAT), 'created_at': self.created_at.strftime(DATETIME_FORMAT),
'status': self.status 'status': self.status
} }

View File

@@ -0,0 +1,32 @@
from flask import Blueprint, jsonify, current_app
from itsdangerous import SignatureExpired
from notifications_utils.url_safe_token import check_token
from app.dao.organisation_dao import dao_get_invited_organisation_user
from app.errors import register_errors, InvalidRequest
accept_organisation_invite_blueprint = Blueprint(
'accept_organisation_invite', __name__,
url_prefix='/organisation-invitation')
register_errors(accept_organisation_invite_blueprint)
@accept_organisation_invite_blueprint.route("/<token>", methods=['GET'])
def accept_organisation_invitation(token):
max_age_seconds = 60 * 60 * 24 * current_app.config['INVITATION_EXPIRATION_DAYS']
try:
invited_user_id = check_token(token,
current_app.config['SECRET_KEY'],
current_app.config['DANGEROUS_SALT'],
max_age_seconds)
except SignatureExpired:
errors = {'invitation':
['Your invitation to GOV.UK Notify has expired. '
'Please ask the person that invited you to send you another one']}
raise InvalidRequest(errors, status_code=400)
invited_user = dao_get_invited_organisation_user(invited_user_id)
return jsonify(data=invited_user.serialize()), 200

View File

@@ -73,7 +73,7 @@ def get_invited_org_users_by_organisation(organisation_id):
@organisation_invite_blueprint.route('/<invited_org_user_id>', methods=['POST']) @organisation_invite_blueprint.route('/<invited_org_user_id>', methods=['POST'])
def update_invite_status(organisation_id, invited_org_user_id): def update_org_invite_status(organisation_id, invited_org_user_id):
fetched = get_invited_org_user(organisation_id=organisation_id, invited_org_user_id=invited_org_user_id) fetched = get_invited_org_user(organisation_id=organisation_id, invited_org_user_id=invited_org_user_id)
data = request.get_json() data = request.get_json()
@@ -81,6 +81,7 @@ def update_invite_status(organisation_id, invited_org_user_id):
fetched.status = data['status'] fetched.status = data['status']
save_invited_org_user(fetched) save_invited_org_user(fetched)
return jsonify(data=fetched.serialize()), 200 return jsonify(data=fetched.serialize()), 200

View File

@@ -1,3 +1,4 @@
from app.models import INVITED_USER_STATUS_TYPES
from app.schema_validation.definitions import uuid from app.schema_validation.definitions import uuid
post_create_organisation_schema = { post_create_organisation_schema = {
@@ -51,7 +52,7 @@ post_update_invited_org_user_status_schema = {
"description": "POST update organisation invite schema", "description": "POST update organisation invite schema",
"type": "object", "type": "object",
"properties": { "properties": {
"status": {"type": "string"} "status": {"enum": INVITED_USER_STATUS_TYPES}
}, },
"required": ["status"] "required": ["status"]
} }

View File

@@ -8,6 +8,8 @@ from app.dao.organisation_dao import (
dao_get_organisation_services, dao_get_organisation_services,
dao_update_organisation, dao_update_organisation,
dao_add_service_to_organisation, dao_add_service_to_organisation,
dao_get_users_for_organisation,
dao_add_user_to_organisation
) )
from app.dao.services_dao import dao_fetch_service_by_id from app.dao.services_dao import dao_fetch_service_by_id
from app.errors import register_errors, InvalidRequest from app.errors import register_errors, InvalidRequest
@@ -18,6 +20,7 @@ from app.organisation.organisation_schema import (
post_link_service_to_organisation_schema, post_link_service_to_organisation_schema,
) )
from app.schema_validation import validate from app.schema_validation import validate
from app.schemas import user_schema
organisation_blueprint = Blueprint('organisation', __name__) organisation_blueprint = Blueprint('organisation', __name__)
register_errors(organisation_blueprint) register_errors(organisation_blueprint)
@@ -90,3 +93,18 @@ def get_organisation_services(organisation_id):
services = dao_get_organisation_services(organisation_id) services = dao_get_organisation_services(organisation_id)
sorted_services = sorted(services, key=lambda s: (-s.active, s.name)) sorted_services = sorted(services, key=lambda s: (-s.active, s.name))
return jsonify([s.serialize_for_org_dashboard() for s in sorted_services]) return jsonify([s.serialize_for_org_dashboard() for s in sorted_services])
@organisation_blueprint.route('/<uuid:organisation_id>/users/<uuid:user_id>', methods=['POST'])
def add_user_to_organisation(organisation_id, user_id):
current_app.logger.info("ADDING new user")
new_org_user = dao_add_user_to_organisation(organisation_id, user_id)
return jsonify(data=user_schema.dump(new_org_user).data), 200
@organisation_blueprint.route('/<uuid:organisation_id>/users', methods=['GET'])
def get_organisation_users(organisation_id):
org_users = dao_get_users_for_organisation(organisation_id)
result = user_schema.dump(org_users, many=True)
return jsonify(data=result.data)

View File

@@ -8,6 +8,7 @@ from app.dao.organisation_dao import (
dao_get_organisation_services, dao_get_organisation_services,
dao_update_organisation, dao_update_organisation,
dao_add_service_to_organisation, dao_add_service_to_organisation,
dao_get_invited_organisation_user
) )
from app.models import Organisation from app.models import Organisation
@@ -104,3 +105,12 @@ def test_get_organisation_by_service_id(notify_db, notify_db_session, sample_ser
assert organisation_1 == sample_organisation assert organisation_1 == sample_organisation
assert organisation_2 == another_org assert organisation_2 == another_org
def test_dao_get_invited_organisation_user(sample_invited_org_user):
invited_org_user = dao_get_invited_organisation_user(sample_invited_org_user.id)
assert invited_org_user == sample_invited_org_user
def test_dao_get_users_for_organisation(sample_organisation, sample_user):
dao

View File

@@ -1,6 +1,5 @@
import json import json
import pytest import pytest
import uuid
from app.models import Notification, SMS_AUTH_TYPE, EMAIL_AUTH_TYPE from app.models import Notification, SMS_AUTH_TYPE, EMAIL_AUTH_TYPE
from tests import create_authorization_header from tests import create_authorization_header

View File

@@ -0,0 +1,18 @@
import json
from flask import current_app
from notifications_utils.url_safe_token import generate_token
from tests import create_authorization_header
def test_accept_organisation_invitation(client, sample_invited_org_user):
token = generate_token(str(sample_invited_org_user.id), current_app.config['SECRET_KEY'],
current_app.config['DANGEROUS_SALT'])
url = '/organisation-invitation/{}'.format(token)
auth_header = create_authorization_header()
response = client.get(url, headers=[('Content-Type', 'application/json'), auth_header])
assert response.status_code == 200
json_resp = json.loads(response.get_data(as_text=True))
assert json_resp['data'] == sample_invited_org_user.serialize()

View File

@@ -109,11 +109,11 @@ def test_get_invited_users_by_service_with_no_invites(admin_request, sample_orga
assert len(json_resp['data']) == 0 assert len(json_resp['data']) == 0
def test_update_invited_user_set_status_to_cancelled(admin_request, sample_invited_org_user): def test_update_org_invited_user_set_status_to_cancelled(admin_request, sample_invited_org_user):
data = {'status': 'cancelled'} data = {'status': 'cancelled'}
json_resp = admin_request.post( json_resp = admin_request.post(
'organisation_invite.update_invite_status', 'organisation_invite.update_org_invite_status',
organisation_id=sample_invited_org_user.organisation_id, organisation_id=sample_invited_org_user.organisation_id,
invited_org_user_id=sample_invited_org_user.id, invited_org_user_id=sample_invited_org_user.id,
_data=data _data=data
@@ -121,11 +121,11 @@ def test_update_invited_user_set_status_to_cancelled(admin_request, sample_invit
assert json_resp['data']['status'] == 'cancelled' assert json_resp['data']['status'] == 'cancelled'
def test_update_invited_user_for_wrong_service_returns_404(admin_request, sample_invited_org_user, fake_uuid): def test_update_org_invited_user_for_wrong_service_returns_404(admin_request, sample_invited_org_user, fake_uuid):
data = {'status': 'cancelled'} data = {'status': 'cancelled'}
json_resp = admin_request.post( json_resp = admin_request.post(
'organisation_invite.update_invite_status', 'organisation_invite.update_org_invite_status',
organisation_id=fake_uuid, organisation_id=fake_uuid,
invited_org_user_id=sample_invited_org_user.id, invited_org_user_id=sample_invited_org_user.id,
_data=data, _data=data,
@@ -134,14 +134,15 @@ def test_update_invited_user_for_wrong_service_returns_404(admin_request, sample
assert json_resp['message'] == 'No result found' assert json_resp['message'] == 'No result found'
def test_update_invited_user_for_invalid_data_returns_400(admin_request, sample_invited_org_user): def test_update_org_invited_user_for_invalid_data_returns_400(admin_request, sample_invited_org_user):
data = {'status': 'garbage'} data = {'status': 'garbage'}
json_resp = admin_request.post( json_resp = admin_request.post(
'organisation_invite.update_invite_status', 'organisation_invite.update_org_invite_status',
organisation_id=sample_invited_org_user.organisation_id, organisation_id=sample_invited_org_user.organisation_id,
invited_org_user_id=sample_invited_org_user.id, invited_org_user_id=sample_invited_org_user.id,
_data=data, _data=data,
_expected_status=404 _expected_status=400
) )
assert json_resp['message'] == 'No result found' assert len(json_resp['errors']) == 1
assert json_resp['errors'][0]['message'] == 'status garbage is not one of [pending, accepted, cancelled]'