def post(resource):
""" Adds one or more documents to a resource. Each document is validated
against the domain schema. If validation passes the document is inserted
and ID_FIELD, LAST_UPDATED and DATE_CREATED along with a link to the
document are returned. If validation fails, a list of validation issues
is returned.
:param resource: name of the resource involved.
.. versionchanged:: 0.0.5
Support for 'application/json' Content-Type .
Support for 'user-restricted resource access'.
.. versionchanged:: 0.0.4
Added the ``reqiores_auth`` decorator.
.. versionchanged:: 0.0.3
JSON links. Superflous ``response`` container removed.
"""
response = {}
date_utc = datetime.utcnow()
schema = app.config['DOMAIN'][resource]['schema']
validator = app.validator(schema, resource)
for key, value in payload().items():
response_item = {}
issues = []
try:
document = parse(value, resource)
validation = validator.validate(document)
if validation:
document[config.LAST_UPDATED] = \
document[config.DATE_CREATED] = date_utc
# if 'user-restricted resource access' is enabled and there's
# an Auth request active, inject the username into the document
username_field = \
app.config['DOMAIN'][resource]['auth_username_field']
if username_field and request.authorization:
document[username_field] = request.authorization.username
document[config.ID_FIELD] = app.data.insert(resource, document)
response_item[config.ID_FIELD] = document[config.ID_FIELD]
response_item[config.LAST_UPDATED] = \
document[config.LAST_UPDATED]
response_item['_links'] = \
{'self': document_link(resource,
response_item[config.ID_FIELD])}
else:
issues.extend(validator.errors)
except ValidationError as e:
raise e
except Exception as e:
issues.append(str(e))
if len(issues):
response_item['issues'] = issues
response_item['status'] = config.STATUS_ERR
else:
response_item['status'] = config.STATUS_OK
response[key] = response_item
return response, None, None, 200
def post(resource):
""" Adds one or more documents to a resource. Each document is validated
against the domain schema. If validation passes the document is inserted
and ID_FIELD, LAST_UPDATED and DATE_CREATED along with a link to the
document are returned. If validation fails, a list of validation issues
is returned.
:param resource: name of the resource involved.
.. versionchanged:: 0.0.5
Support for 'application/json' Content-Type .
Support for 'user-restricted resource access'.
.. versionchanged:: 0.0.4
Added the ``reqiores_auth`` decorator.
.. versionchanged:: 0.0.3
JSON links. Superflous ``response`` container removed.
"""
response = {}
date_utc = datetime.utcnow()
schema = app.config['DOMAIN'][resource]['schema']
validator = app.validator(schema, resource)
for key, value in payload().items():
response_item = {}
issues = []
try:
document = parse(value, resource)
validation = validator.validate(document)
if validation:
document[config.LAST_UPDATED] = \
document[config.DATE_CREATED] = date_utc
# if 'user-restricted resource access' is enabled and there's
# an Auth request active, inject the username into the document
username_field = \
app.config['DOMAIN'][resource]['auth_username_field']
if username_field and request.authorization:
document[username_field] = request.authorization.username
document[config.ID_FIELD] = app.data.insert(resource, document)
response_item[config.ID_FIELD] = document[config.ID_FIELD]
response_item[config.LAST_UPDATED] = \
document[config.LAST_UPDATED]
response_item['_links'] = \
{'self': document_link(resource,
response_item[config.ID_FIELD])}
else:
issues.extend(validator.errors)
except ValidationError as e:
raise e
except Exception as e:
issues.append(str(e))
if len(issues):
response_item['issues'] = issues
response_item['status'] = config.STATUS_ERR
else:
response_item['status'] = config.STATUS_OK
response[key] = response_item
return response, None, None, 200
def post(resource):
""" Adds one or more documents to a resource. Each document is validated
against the domain schema. If validation passes the document is inserted
and ID_FIELD, LAST_UPDATED and DATE_CREATED along with a link to the
document are returned. If validation fails, a list of validation issues
is returned.
:param resource: name of the resource involved.
.. versionchanged:: 0.0.6
Support for bulk inserts.
Please note: validation constraints are checked against the database,
and not between the payload documents themselves. This causes an
interesting corner case: in the event of a multiple documents payload
where two or more documents carry the same value for a field where the
'unique' constraint is set, the payload will validate successfully, as
there are no duplicates in the database (yet). If this is an issue, the
client can always send the documents once at a time for insertion, or
validate locally before submitting the payload to the API.
.. versionchanged:: 0.0.5
Support for 'application/json' Content-Type .
Support for 'user-restricted resource access'.
.. versionchanged:: 0.0.4
Added the ``requires_auth`` decorator.
.. versionchanged:: 0.0.3
JSON links. Superflous ``response`` container removed.
"""
date_utc = datetime.utcnow().replace(microsecond=0)
schema = app.config['DOMAIN'][resource]['schema']
validator = app.validator(schema, resource)
documents = []
issues = []
# validation, and additional fields
payl = payload()
for key, value in payl.items():
document = []
doc_issues = []
try:
document = parse(value, resource)
validation = validator.validate(document)
if validation:
# validation is successful
document[config.LAST_UPDATED] = \
document[config.DATE_CREATED] = date_utc
# if 'user-restricted resource access' is enabled and there's
# an Auth request active, inject the username into the document
username_field = \
app.config['DOMAIN'][resource]['auth_username_field']
if username_field and request.authorization:
document[username_field] = request.authorization.username
else:
# validation errors added to list of document issues
doc_issues.extend(validator.errors)
except ValidationError as e:
raise e
except Exception as e:
# most likely a problem with the incoming payload, report back to
# the client as if it was a validation issue
doc_issues.append(str(e))
issues.append(doc_issues)
if len(doc_issues) == 0:
documents.append(document)
# bulk insert
if len(documents):
ids = app.data.insert(resource, documents)
# build response payload
response = {}
for key, doc_issues in zip(payl.keys(), issues):
response_item = {}
if len(doc_issues):
response_item['status'] = config.STATUS_ERR
response_item['issues'] = doc_issues
else:
response_item['status'] = config.STATUS_OK
response_item[config.ID_FIELD] = ids.pop(0)
document = documents.pop(0)
response_item[config.LAST_UPDATED] = document[config.LAST_UPDATED]
response_item['etag'] = document_etag(document)
response_item['_links'] = \
{'self': document_link(resource,
response_item[config.ID_FIELD])}
response[key] = response_item
return response, None, None, 200
def post(resource):
""" Adds one or more documents to a resource. Each document is validated
against the domain schema. If validation passes the document is inserted
and ID_FIELD, LAST_UPDATED and DATE_CREATED along with a link to the
document are returned. If validation fails, a list of validation issues
is returned.
:param resource: name of the resource involved.
.. versionchanged:: 0.0.6
Support for bulk inserts.
Please note: validation constraints are checked against the database,
and not between the payload documents themselves. This causes an
interesting corner case: in the event of a multiple documents payload
where two or more documents carry the same value for a field where the
'unique' constraint is set, the payload will validate successfully, as
there are no duplicates in the database (yet). If this is an issue, the
client can always send the documents once at a time for insertion, or
validate locally before submitting the payload to the API.
.. versionchanged:: 0.0.5
Support for 'application/json' Content-Type .
Support for 'user-restricted resource access'.
.. versionchanged:: 0.0.4
Added the ``requires_auth`` decorator.
.. versionchanged:: 0.0.3
JSON links. Superflous ``response`` container removed.
"""
date_utc = datetime.utcnow().replace(microsecond=0)
schema = app.config['DOMAIN'][resource]['schema']
validator = app.validator(schema, resource)
documents = []
issues = []
# validation, and additional fields
payl = payload()
for key, value in payl.items():
document = []
doc_issues = []
try:
document = parse(value, resource)
validation = validator.validate(document)
if validation:
# validation is successful
document[config.LAST_UPDATED] = \
document[config.DATE_CREATED] = date_utc
# if 'user-restricted resource access' is enabled and there's
# an Auth request active, inject the username into the document
username_field = \
app.config['DOMAIN'][resource]['auth_username_field']
if username_field and request.authorization:
document[username_field] = request.authorization.username
else:
# validation errors added to list of document issues
doc_issues.extend(validator.errors)
except ValidationError as e:
raise e
except Exception as e:
# most likely a problem with the incoming payload, report back to
# the client as if it was a validation issue
doc_issues.append(str(e))
issues.append(doc_issues)
if len(doc_issues) == 0:
documents.append(document)
# bulk insert
if len(documents):
ids = app.data.insert(resource, documents)
# build response payload
response = {}
for key, doc_issues in zip(payl.keys(), issues):
response_item = {}
if len(doc_issues):
response_item['status'] = config.STATUS_ERR
response_item['issues'] = doc_issues
else:
response_item['status'] = config.STATUS_OK
response_item[config.ID_FIELD] = ids.pop(0)
document = documents.pop(0)
response_item[config.LAST_UPDATED] = document[config.LAST_UPDATED]
response_item['etag'] = document_etag(document)
response_item['_links'] = \
{'self': document_link(resource,
response_item[config.ID_FIELD])}
response[key] = response_item
return response, None, None, 200
