Merged with master.

This commit is contained in:
Nicholas Staples
2016-01-22 14:46:03 +00:00
9 changed files with 177 additions and 12 deletions

View File

@@ -31,5 +31,5 @@ def get_model_templates(template_id=None, service_id=None):
elif template_id: elif template_id:
return Template.query.filter_by(id=template_id).one() return Template.query.filter_by(id=template_id).one()
elif service_id: elif service_id:
return Template.query.filter_by(service=Service.query.get(service_id)).one() return Template.query.filter_by(service=Service.query.get(service_id)).all()
return Template.query.all() return Template.query.all()

View File

@@ -1,6 +1,7 @@
from sqlalchemy import UniqueConstraint
from . import db from . import db
import datetime import datetime
from sqlalchemy.dialects.postgresql import UUID from sqlalchemy.dialects.postgresql import UUID
from app.encryption import ( from app.encryption import (
hashpw, hashpw,
@@ -95,6 +96,10 @@ class ApiKey(db.Model):
service = db.relationship('Service', backref=db.backref('api_keys', lazy='dynamic')) service = db.relationship('Service', backref=db.backref('api_keys', lazy='dynamic'))
expiry_date = db.Column(db.DateTime) expiry_date = db.Column(db.DateTime)
__table_args__ = (
UniqueConstraint('service_id', 'name', name='uix_service_to_key_name'),
)
TEMPLATE_TYPES = ['sms', 'email', 'letter'] TEMPLATE_TYPES = ['sms', 'email', 'letter']
@@ -123,7 +128,6 @@ class Template(db.Model):
class Job(db.Model): class Job(db.Model):
__tablename__ = 'jobs' __tablename__ = 'jobs'
id = db.Column(UUID(as_uuid=True), primary_key=True) id = db.Column(UUID(as_uuid=True), primary_key=True)

View File

@@ -13,7 +13,7 @@ from app.dao.templates_dao import (
from app.dao.api_key_dao import (save_model_api_key, get_model_api_keys, get_unsigned_secret) from app.dao.api_key_dao import (save_model_api_key, get_model_api_keys, get_unsigned_secret)
from app.models import ApiKey from app.models import ApiKey
from app.schemas import ( from app.schemas import (
services_schema, service_schema, template_schema, api_keys_schema) services_schema, service_schema, template_schema, templates_schema, api_keys_schema)
from flask import Blueprint from flask import Blueprint
service = Blueprint('service', __name__) service = Blueprint('service', __name__)
@@ -65,8 +65,9 @@ def update_service(service_id):
@service.route('/<int:service_id>', methods=['GET']) @service.route('/<int:service_id>', methods=['GET'])
@service.route('', methods=['GET']) @service.route('', methods=['GET'])
def get_service(service_id=None): def get_service(service_id=None):
user_id = request.args.get('user_id', None)
try: try:
services = get_model_services(service_id=service_id) services = get_model_services(service_id=service_id, user_id=user_id)
except DataError: except DataError:
return jsonify(result="error", message="Invalid service id"), 400 return jsonify(result="error", message="Invalid service id"), 400
except NoResultFound: except NoResultFound:
@@ -183,3 +184,21 @@ def update_template(service_id, template_id):
except DAOException as e: except DAOException as e:
return jsonify(result="error", message=str(e)), 400 return jsonify(result="error", message=str(e)), 400
return jsonify(data=template_schema.dump(template).data), status_code return jsonify(data=template_schema.dump(template).data), status_code
@service.route('/<int:service_id>/template/<int:template_id>', methods=['GET'])
@service.route('/<int:service_id>/template', methods=['GET'])
def get_service_template(service_id, template_id=None):
try:
templates = get_model_templates(service_id=service_id, template_id=template_id)
except DataError:
return jsonify(result="error", message="Invalid template id"), 400
except NoResultFound:
return jsonify(result="error", message="Template not found"), 404
if isinstance(templates, list):
data, errors = templates_schema.dump(templates)
else:
data, errors = template_schema.dump(templates)
if errors:
return jsonify(result="error", message=str(errors))
return jsonify(data=data)

View File

@@ -137,7 +137,7 @@ def send_user_code(user_id):
@user.route('/<int:user_id>', methods=['GET']) @user.route('/<int:user_id>', methods=['GET'])
@user.route('/', methods=['GET']) @user.route('', methods=['GET'])
def get_user(user_id=None): def get_user(user_id=None):
try: try:
users = get_model_users(user_id=user_id) users = get_model_users(user_id=user_id)

View File

@@ -0,0 +1,26 @@
"""empty message
Revision ID: 0008_unique_service_to_key_name
Revises: 0007_change_to_api_keys
Create Date: 2016-01-21 16:14:51.773001
"""
# revision identifiers, used by Alembic.
revision = '0008_unique_service_to_key_name'
down_revision = '0007_change_to_api_keys'
from alembic import op
import sqlalchemy as sa
def upgrade():
### commands auto generated by Alembic - please adjust! ###
op.create_unique_constraint('uix_service_to_key_name', 'api_key', ['service_id', 'name'])
### end Alembic commands ###
def downgrade():
### commands auto generated by Alembic - please adjust! ###
op.drop_constraint('uix_service_to_key_name', 'api_key', type_='unique')
### end Alembic commands ###

View File

@@ -76,7 +76,17 @@ def test_should_allow_valid_token(notify_api, notify_db, notify_db_session, samp
with notify_api.test_request_context(): with notify_api.test_request_context():
with notify_api.test_client() as client: with notify_api.test_client() as client:
token = __create_get_token(sample_api_key.service_id) token = __create_get_token(sample_api_key.service_id)
response = client.get(url_for('service.get_service'), response = client.get(url_for('service.get_service', service_id=sample_api_key.service_id),
headers={'Authorization': 'Bearer {}'.format(token)})
assert response.status_code == 200
def test_should_allow_valid_token_for_request_with_path_params(notify_api, notify_db, notify_db_session,
sample_api_key):
with notify_api.test_request_context():
with notify_api.test_client() as client:
token = __create_get_token(sample_api_key.service_id)
response = client.get(url_for('service.get_service', service_id=sample_api_key.service_id),
headers={'Authorization': 'Bearer {}'.format(token)}) headers={'Authorization': 'Bearer {}'.format(token)})
assert response.status_code == 200 assert response.status_code == 200
@@ -89,7 +99,7 @@ def test_should_allow_valid_token_when_service_has_multiple_keys(notify_api, not
api_key = ApiKey(**data) api_key = ApiKey(**data)
save_model_api_key(api_key) save_model_api_key(api_key)
token = __create_get_token(sample_api_key.service_id) token = __create_get_token(sample_api_key.service_id)
response = client.get(url_for('service.get_service'), response = client.get(url_for('service.get_service', service_id=sample_api_key.service_id),
headers={'Authorization': 'Bearer {}'.format(token)}) headers={'Authorization': 'Bearer {}'.format(token)})
assert response.status_code == 200 assert response.status_code == 200
@@ -205,10 +215,16 @@ def test_authentication_returns_token_expired_when_service_uses_expired_key_and_
def __create_get_token(service_id): def __create_get_token(service_id):
return create_jwt_token(request_method="GET", if service_id:
request_path=url_for('service.get_service'), return create_jwt_token(request_method="GET",
secret=get_unsigned_secrets(service_id)[0], request_path=url_for('service.get_service', service_id=service_id),
client_id=service_id) secret=get_unsigned_secrets(service_id)[0],
client_id=service_id)
else:
return create_jwt_token(request_method="GET",
request_path=url_for('service.get_service'),
secret=get_unsigned_secrets(service_id)[0],
client_id=service_id)
def __create_post_token(service_id, request_body): def __create_post_token(service_id, request_body):

View File

@@ -73,3 +73,16 @@ def test_get_unsigned_secret_returns_key(notify_api,
unsigned_api_key = get_unsigned_secret(sample_api_key.id) unsigned_api_key = get_unsigned_secret(sample_api_key.id)
assert sample_api_key.secret != unsigned_api_key assert sample_api_key.secret != unsigned_api_key
assert unsigned_api_key == _get_secret(sample_api_key.secret) assert unsigned_api_key == _get_secret(sample_api_key.secret)
def test_should_not_allow_duplicate_key_names_per_service(notify_api,
notify_db,
notify_db_session,
sample_api_key):
api_key = ApiKey(
**{'id': sample_api_key.id + 1, 'service_id': sample_api_key.service_id, 'name': sample_api_key.name})
try:
save_model_api_key(api_key)
fail("should throw IntegrityError")
except:
pass

View File

@@ -2,6 +2,7 @@ import pytest
from app.dao.services_dao import ( from app.dao.services_dao import (
save_model_service, get_model_services, DAOException, delete_model_service) save_model_service, get_model_services, DAOException, delete_model_service)
from tests.app.conftest import sample_service as create_sample_service from tests.app.conftest import sample_service as create_sample_service
from tests.app.conftest import sample_user as create_sample_user
from app.models import Service from app.models import Service
@@ -47,6 +48,23 @@ def test_get_user_service(notify_api, notify_db, notify_db_session, sample_user)
assert Service.query.count() == 1 assert Service.query.count() == 1
def test_get_services_for_user(notify_api, notify_db, notify_db_session, sample_service):
assert Service.query.count() == 1
service_name = "Random service"
second_user = create_sample_user(notify_db, notify_db_session, 'an@other.gov.uk')
create_sample_service(notify_db, notify_db_session, service_name='another service', user=second_user)
sample_service = create_sample_service(notify_db,
notify_db_session,
service_name=service_name,
user=sample_service.users[0])
assert Service.query.count() == 3
services = get_model_services(user_id=sample_service.users[0].id)
assert len(services) == 2
assert service_name in [x.name for x in services]
assert 'Sample service' in [x.name for x in services]
def test_missing_user_attribute(notify_api, notify_db, notify_db_session): def test_missing_user_attribute(notify_api, notify_db, notify_db_session):
assert Service.query.count() == 0 assert Service.query.count() == 0
try: try:

View File

@@ -6,6 +6,7 @@ from app.dao.services_dao import save_model_service
from app.models import (Service, ApiKey, Template) from app.models import (Service, ApiKey, Template)
from tests import create_authorization_header from tests import create_authorization_header
from tests.app.conftest import sample_user as create_sample_user from tests.app.conftest import sample_user as create_sample_user
from tests.app.conftest import sample_service as create_sample_service
def test_get_service_list(notify_api, notify_db, notify_db_session, sample_service, sample_admin_service_id): def test_get_service_list(notify_api, notify_db, notify_db_session, sample_service, sample_admin_service_id):
@@ -45,6 +46,26 @@ def test_get_service(notify_api, notify_db, notify_db_session, sample_service, s
assert json_resp['data']['id'] == sample_service.id assert json_resp['data']['id'] == sample_service.id
def test_get_service_for_user(notify_api, notify_db, notify_db_session, sample_service):
second_user = create_sample_user(notify_db, notify_db_session, 'an@other.gov.uk')
create_sample_service(notify_db, notify_db_session, service_name='Second Service', user=second_user)
create_sample_service(notify_db, notify_db_session, service_name='Another Service', user=sample_service.users[0])
with notify_api.test_request_context():
with notify_api.test_client() as client:
auth_header = create_authorization_header(
path='/service',
method='GET')
resp = client.get('/service?user_id={}'.format(sample_service.users[0].id),
headers=[auth_header])
assert resp.status_code == 200
json_resp = json.loads(resp.get_data(as_text=True))
assert len(json_resp['data']) == 2
print(x for x in json_resp['data'])
assert 'Another Service' in [x.get('name') for x in json_resp['data']]
assert 'Sample service' in [x.get('name') for x in json_resp['data']]
assert 'Second Service' not in [x.get('name') for x in json_resp['data']]
def test_post_service(notify_api, notify_db, notify_db_session, sample_user, sample_admin_service_id): def test_post_service(notify_api, notify_db, notify_db_session, sample_user, sample_admin_service_id):
""" """
Tests POST endpoint '/' to create a service. Tests POST endpoint '/' to create a service.
@@ -547,3 +568,51 @@ def test_create_template_unicode_content(notify_api, notify_db, notify_db_sessio
assert json_resp['data']['name'] == template_name assert json_resp['data']['name'] == template_name
assert json_resp['data']['template_type'] == template_type assert json_resp['data']['template_type'] == template_type
assert json_resp['data']['content'] == template_content assert json_resp['data']['content'] == template_content
def test_get_template_list(notify_api, notify_db, notify_db_session, sample_template):
"""
Tests GET endpoint '/' to retrieve entire template list.
"""
with notify_api.test_request_context():
with notify_api.test_client() as client:
auth_header = create_authorization_header(
service_id=sample_template.service_id,
path=url_for(
'service.get_service_template',
service_id=sample_template.service_id),
method='GET')
response = client.get(
url_for(
'service.get_service_template',
service_id=sample_template.service_id),
headers=[auth_header])
assert response.status_code == 200
json_resp = json.loads(response.get_data(as_text=True))
assert len(json_resp['data']) == 1
assert json_resp['data'][0]['name'] == sample_template.name
assert json_resp['data'][0]['id'] == sample_template.id
def test_get_template(notify_api, notify_db, notify_db_session, sample_template):
"""
Tests GET endpoint '/<template_id>' to retrieve a single template.
"""
with notify_api.test_request_context():
with notify_api.test_client() as client:
auth_header = create_authorization_header(
service_id=sample_template.service_id,
path=url_for(
'service.get_service_template',
template_id=sample_template.id,
service_id=sample_template.service_id),
method='GET')
resp = client.get(url_for(
'service.get_service_template',
template_id=sample_template.id,
service_id=sample_template.service_id),
headers=[auth_header])
assert resp.status_code == 200
json_resp = json.loads(resp.get_data(as_text=True))
assert json_resp['data']['name'] == sample_template.name
assert json_resp['data']['id'] == sample_template.id