Add schemas, endpoints and supporting tests

This commit is contained in:
Ken Tsang
2017-03-14 15:25:36 +00:00
parent ac8e55628c
commit 9e4b1b2bfc
8 changed files with 271 additions and 0 deletions

View File

@@ -110,9 +110,11 @@ def register_blueprint(application):
def register_v2_blueprints(application):
from app.v2.notifications.post_notifications import notification_blueprint as post_notifications
from app.v2.notifications.get_notifications import notification_blueprint as get_notifications
from app.v2.template.get_template import template_blueprint
application.register_blueprint(post_notifications)
application.register_blueprint(get_notifications)
application.register_blueprint(template_blueprint)
def init_app(app):

View File

@@ -320,6 +320,21 @@ class Template(db.Model):
_external=True
)
def serialize(self):
serialized = {
"id": self.id,
"type": self.template_type,
"created_at": self.created_at.strftime(DATETIME_FORMAT),
"updated_at": self.updated_at.strftime(DATETIME_FORMAT) if self.updated_at else None,
"created_by": self.created_by.email_address,
"version": self.version,
"body": self.content,
"subject": self.subject if self.template_type == EMAIL_TYPE else None
}
return serialized
class TemplateHistory(db.Model):
__tablename__ = 'templates_history'
@@ -343,6 +358,21 @@ class TemplateHistory(db.Model):
nullable=False,
default=NORMAL)
def serialize(self):
serialized = {
"id": self.id,
"type": self.template_type,
"created_at": self.created_at.strftime(DATETIME_FORMAT),
"updated_at": self.updated_at.strftime(DATETIME_FORMAT) if self.updated_at else None,
"created_by": self.created_by.email_address,
"version": self.version,
"body": self.content,
"subject": self.subject if self.template_type == EMAIL_TYPE else None
}
return serialized
MMG_PROVIDER = "mmg"
FIRETEXT_PROVIDER = "firetext"

View File

@@ -0,0 +1,7 @@
from flask import Blueprint
from app.v2.errors import register_errors
template_blueprint = Blueprint("v2_template", __name__, url_prefix='/v2/template')
register_errors(template_blueprint)

View File

@@ -0,0 +1,31 @@
import uuid
from flask import jsonify, request
from werkzeug.exceptions import abort
from app import api_user
from app.dao import templates_dao
from app.schema_validation import validate
from app.v2.template import template_blueprint
from app.v2.template.template_schemas import get_template_by_id_request
@template_blueprint.route("/<template_id>", methods=['GET'])
@template_blueprint.route("/<template_id>/version/<version>", methods=['GET'])
def get_template_by_id(template_id, version=None):
try:
casted_id = uuid.UUID(template_id)
_data = {}
_data['id'] = template_id
if version:
_data['version'] = int(version)
data = validate(_data, get_template_by_id_request)
except ValueError or AttributeError:
abort(404)
template = templates_dao.dao_get_template_by_id_and_service_id(
casted_id, api_user.service_id, data.get('version'))
return jsonify(template.serialize()), 200

View File

@@ -0,0 +1,41 @@
from app.models import TEMPLATE_TYPES
from app.schema_validation.definitions import uuid
get_template_by_id_request = {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "schema for query parameters allowed when getting list of notifications",
"type": "object",
"properties": {
"id": uuid,
"version": {"type": ["integer", "null"], "minimum": 1}
},
"required": ["id"],
"additionalProperties": False,
}
get_template_by_id_response = {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "GET template by id schema response",
"type": "object",
"title": "reponse v2/template",
"properties": {
"id": uuid,
"type": {"enum": TEMPLATE_TYPES},
"created_at": {
"format": "date-time",
"type": "string",
"description": "Date+time created"
},
"updated_at": {
"format": "date-time",
"type": "string",
"description": "Date+time updated"
},
"created_by": {"type": "string"},
"version": {"type": "integer"},
"body": {"type": "string"},
"subject": {"type": ["string", "null"]}
},
"required": ["id", "type", "created_at", "updated_at", "version", "created_by", "body"]
}