def get(self, path: str) -> Response:
"""
Retrieve a collection of items from the database.
:param path : Path of the Collection
:return : collection of items
"""
endpoint_ = checkEndpoint("GET", path)
if not endpoint_['method']:
# If endpoint and Get method not supported in the API
abort(endpoint_['status'])
return item_collection_get_response(path)
def put(self, path, int_list="") -> Response:
"""
To insert multiple objects into the database
:param path: endpoint
:param int_list: Optional String containing ',' separated ID's
:return:
"""
endpoint_ = checkEndpoint("PUT", path)
if not endpoint_['method']:
# If endpoint and PUT method is not supported in the API
abort(endpoint_['status'])
return items_put_response(path, int_list)
def post(self, path: str) -> Response:
"""
Method executed for POST requests.
Used to update a non-collection class.
:param path - Path for Item type ( Specified in APIDoc @id)
"""
auth_response = check_authentication_response()
if isinstance(auth_response, Response):
return auth_response
endpoint_ = checkEndpoint("POST", path)
if endpoint_['method']:
object_ = json.loads(request.data.decode('utf-8'))
if path in get_doc().parsed_classes and "{}Collection".format(path) not in get_doc(
).collections:
obj_type = getType(path, "POST")
if check_read_only_props(obj_type, object_):
if object_["@type"] == obj_type and check_required_props(
obj_type, object_) and validObject(object_):
try:
crud.update_single(
object_=object_,
session=get_session(),
api_name=get_api_name(),
path=path)
headers_ = [
{"Location": "{}/{}/".format(
get_hydrus_server_url(), get_api_name(), path)}]
response = {
"message": "Object successfully updated"}
return set_response_headers(
jsonify(response), headers=headers_)
except (ClassNotFound, InstanceNotFound,
InstanceExists, PropertyNotFound) as e:
status_code, message = e.get_HTTP()
return set_response_headers(
jsonify(message), status_code=status_code)
return set_response_headers(
jsonify({400: "Data is not valid"}), status_code=400)
else:
abort(405)
abort(endpoint_['status'])
def get(self, path: str) -> Response:
"""
Retrieve a collection of items from the database.
"""
auth_response = check_authentication_response()
if isinstance(auth_response, Response):
return auth_response
endpoint_ = checkEndpoint("GET", path)
if endpoint_['method']:
# If endpoint and GET method is supported in the API
if path in get_doc().collections:
# If collection name in document's collections
collection = get_doc().collections[path]["collection"]
try:
# Get collection details from the database
response = crud.get_collection(get_api_name(),
collection.class_.title,
session=get_session(),
path=path)
return set_response_headers(
jsonify(hydrafy(response, path=path)))
except ClassNotFound as e:
status_code, message = e.get_HTTP()
return set_response_headers(jsonify(message),
status_code=status_code)
# If class is supported
elif path in get_doc().parsed_classes and "{}Collection".format(
path) not in get_doc().collections:
try:
class_type = get_doc().parsed_classes[path]['class'].title
response = crud.get_single(class_type,
api_name=get_api_name(),
session=get_session(),
path=path)
return set_response_headers(
jsonify(hydrafy(response, path=path)))
except (ClassNotFound, InstanceNotFound) as e:
status_code, message = e.get_HTTP()
return set_response_headers(jsonify(message),
status_code=status_code)
abort(endpoint_['status'])
def put(self, path, int_list="") -> Response:
"""
To insert multiple objects into the database
:param path: endpoint
:param int_list: Optional String containing ',' separated ID's
:return:
"""
auth_response = check_authentication_response()
if isinstance(auth_response, Response):
return auth_response
endpoint_ = checkEndpoint("PUT", path)
if endpoint_['method']:
# If endpoint and PUT method is supported in the API
object_ = json.loads(request.data.decode('utf-8'))
object_ = object_["data"]
if path in get_doc().collections:
# If collection name in document's collections
collection = get_doc().collections[path]["collection"]
# title of HydraClass object corresponding to collection
obj_type = collection.class_.title
if validObjectList(object_):
type_result = type_match(object_, obj_type)
# If Item in request's JSON is a valid object
# ie. @type is one of the keys in object_
if type_result:
# If the right Item type is being added to the
# collection
try:
# Insert object and return location in Header
object_id = crud.insert_multiple(
objects_=object_, session=get_session(), id_=int_list)
headers_ = [{"Location": "{}{}/{}/{}".format(
get_hydrus_server_url(), get_api_name(), path, object_id)}]
response = {
"message": "Object with ID {} successfully added".format(object_id)}
return set_response_headers(
jsonify(response), headers=headers_, status_code=201)
except (ClassNotFound, InstanceExists, PropertyNotFound) as e:
status_code, message = e.get_HTTP()
return set_response_headers(jsonify(message), status_code=status_code)
return set_response_headers(jsonify({400: "Data is not valid"}), status_code=400)
abort(endpoint_['status'])
def put(self, path: str) -> Response:
"""
Method executed for PUT requests.
Used to add an item to a collection
:param path - Path for Item type ( Specified in APIDoc @id)
"""
auth_response = check_authentication_response()
if isinstance(auth_response, Response):
return auth_response
endpoint_ = checkEndpoint("PUT", path)
if endpoint_['method']:
# If endpoint and PUT method is supported in the API
object_ = json.loads(request.data.decode('utf-8'))
if path in get_doc().collections:
# If collection name in document's collections
collection = get_doc().collections[path]["collection"]
# title of HydraClass object corresponding to collection
obj_type = collection.class_.title
if validObject(object_):
# If Item in request's JSON is a valid object
# ie. @type is one of the keys in object_
if object_["@type"] == obj_type:
# If the right Item type is being added to the
# collection
try:
# Insert object and return location in Header
object_id = crud.insert(object_=object_,
session=get_session())
headers_ = [{
"Location":
"{}/{}/{}".format(get_hydrus_server_url(),
get_api_name(), path,
object_id)
}]
response = {
"message":
"Object with ID {} successfully added".format(
object_id)
}
return set_response_headers(jsonify(response),
headers=headers_,
status_code=201)
except (ClassNotFound, InstanceExists,
PropertyNotFound) as e:
status_code, message = e.get_HTTP()
return set_response_headers(
jsonify(message), status_code=status_code)
return set_response_headers(jsonify({400:
"Data is not valid"}),
status_code=400)
elif path in get_doc().parsed_classes and "{}Collection".format(
path) not in get_doc().collections:
# If path is in parsed_classes but is not a collection
obj_type = getType(path, "PUT")
if object_["@type"] == obj_type:
if validObject(object_):
try:
object_id = crud.insert(object_=object_,
session=get_session())
headers_ = [{
"Location":
"{}/{}/".format(get_hydrus_server_url(),
get_api_name(), path)
}]
response = {"message": "Object successfully added"}
return set_response_headers(jsonify(response),
headers=headers_,
status_code=201)
except (ClassNotFound, InstanceExists,
PropertyNotFound) as e:
status_code, message = e.get_HTTP()
return set_response_headers(
jsonify(message), status_code=status_code)
return set_response_headers(jsonify({400:
"Data is not valid"}),
status_code=400)
abort(endpoint_['status'])
