def put_job_without_id():
"""PUT Job without id
Create a new Job entry without specifying the job_id. This is the
preferred method for creating new jobs, as the job_id input has to match
the MongoDB id pattern.
Returns
-------
response : dict
JSON response to this PUT Request
"""
# get the data
data = request.get_json()
if data is None:
data = dict()
# if a user is logged in, bind the job to this user
_filter = get_user_bound_filter(roles=['admin'])
data.update(_filter)
# create the Job
try:
job = Job(**data)
job.create()
except Exception as e:
return jsonify({'status': 500, 'message': str(e)}), 500
return jsonify(job.to_dict(stringify=True)), 201
def run_job(job_id):
# check if a user is logged in
_filter = get_user_bound_filter(roles=['admin'])
# get the requested Job
job = Job.get(job_id, filter=_filter)
if job is None:
return jsonify({
'status': 404,
'message': 'No Job of id %s' % job_id
}), 404
# start the job
if job.started is None:
# try:
job.start()
# except Exception as e:
# return jsonify({'status': 500, 'message': str(e)}), 500
# return the job
return jsonify(job.to_dict(stringify=True)), 202
# job was already started
else:
return jsonify({
'status': 409,
'message': 'The job %s was already started' % job_id
}), 409
def post(self):
"""Filter Jobs
Return all Job instances filtered by the passed filter. If
Authentication is enabled, a user filter will be added automatically.
The filter has to be passed in JSON POST body. The header needs to set
Content-Type: application/json
Returns
-------
response : JSON
A JSON serialized response of all filtered Jobs
"""
# check if a user is logged in
user_filter = get_user_bound_filter(roles=['admin'])
# check the body
body = request.get_json()
if body is None:
body = {}
_filter = {"$and": [user_filter, body]}
# get the jobs
jobs = Job.get_all(filter=_filter)
return {
'found': len(jobs),
'jobs': [job.to_dict(stringify=True) for job in jobs]
}, 200
def get(self, job_id):
"""GET Job
GET request for an Job of id job_id
Parameters
----------
job_id : string
ObjectId of the requested Job.
Returns
-------
response : dict
JSON response to this GET Request
"""
# check if a user is logged in
_filter = get_user_bound_filter(roles=['admin'])
# get the Job
job = Job.get(job_id, filter=_filter)
# return
if job is None:
return {'status': 404, 'message': 'No Job of id %s' % job_id}
else:
return job.to_dict(stringify=True)
def delete(self, job_id):
# check if a user is logged in
# check if a user is logged in
_filter = get_user_bound_filter(roles=['admin'])
# get the job
job = Job.get(job_id, filter=_filter)
if job is None:
return {
'status': 404,
'message': 'No job of id %s found' % job_id
}, 404
# delete
if job.delete():
return {
'status': 200,
'acknowledged': True,
'message': 'Job of ID %s deleted.' % job_id
}, 200
else:
return {
'status': 500,
'message': 'Something went horribly wrong.'
}, 500
def delete(self):
# check if a user is logged in
_filter = get_user_bound_filter(roles=['admin'])
success, total = Job.delete_all(filter=_filter)
return {
'status': 200,
'acknowledged': success == total,
'deleted': success,
'total': total,
'message': 'Deleted %d of %d Jobs' % (success, total)
}, 200
def put(self, job_id):
"""PUT request
Handle a PUT request. A new job will be created using the passed
data. If job_id is given, The function will try to create a Job of
that given job_id.
Parameters
----------
job_id : string
ObjectId of the Job to be created. Has to be a 12 byte name or a
24 byte hex.
Returns
-------
response : dict
JSON response to this PUT Request
"""
# check for existing job id
if Job.id_exists(job_id):
return {
'status': 409,
'message': 'A job of id %s already exists' % job_id
}, 409
# get the passed data
data = request.get_json()
if data is None:
data = dict()
# if a user is logged in, bind the job to this user
_filter = get_user_bound_filter(roles=['admin'])
data.update(_filter)
# create the Job
try:
job = Job(_id=job_id, **data)
job.create()
except InvalidId as e:
return {'status': 505, 'message': str(e)}, 505
except Exception as e:
return {'status': 500, 'message': str(e)}, 500
# return
return job.to_dict(stringify=True), 201
def post(self, job_id):
"""POST request
Handle a POST request to the job of job_id. This will update the
job, as long as it was created, but not jet started. The data to be
updated has to be sent as request data.
Parameters
----------
job_id : string
ObjectId of the requested Job.
Returns
-------
response : dict
JSON response to this POST Request
"""
# check if a user is logged in
_filter = get_user_bound_filter(roles=['admin'])
# get the job
job = Job.get(job_id, filter=_filter)
if job is None:
return {'status': 404, 'message': 'No Job of id %s' % job_id}
# get the data
data = request.get_json()
if len(data.keys()) == 0:
return {'stauts': 412, 'message': 'No data received.'}, 412
try:
job.update(data=data)
except Exception as e:
return {'status': 500, 'message': str(e)}
return job.to_dict(stringify=True), 200
def get(self):
"""Get all Jobs
If Authentication is enabled, the Jobs will be be filtered for all
Job instances the current user is authorized for. A superuser will
always see all jobs.
Returns
-------
response : JSON
A JSON serialized response of all found Jobs
"""
# check if a user is logged in
_filter = get_user_bound_filter(roles=['admin'])
# get the jobs
jobs = Job.get_all(filter=_filter)
return {
'found': len(jobs),
'jobs': [job.to_dict(stringify=True) for job in jobs]
}, 200