restructure corpus routes file and add new decorators

app/contributions/routes.py

@@ -2,20 +2,18 @@ from flask import (
     abort,
     current_app,
     flash,
+    jsonify,
     Markup,
     redirect,
     render_template,
+    request,
     url_for
 )
 from flask_login import login_required, current_user
 from threading import Thread
 from app import db
-from app.decorators import permission_required 
+from app.decorators import content_negotiation, permission_required
-from app.models import (
+from app.models import SpaCyNLPPipelineModel, TesseractOCRPipelineModel
-    Permission,
-    SpaCyNLPPipelineModel,
-    TesseractOCRPipelineModel
-)
 from . import bp
 from .forms import (
     CreateSpaCyNLPPipelineModelForm,
@@ -39,6 +37,126 @@ def contributions():
     )
 
 
+##############################################################################
+# SpaCy NLP Pipeline Models                                                  #
+##############################################################################
+#region spacy-nlp-pipeline-models
+@bp.route('/spacy-nlp-pipeline-models')
+def spacy_nlp_pipeline_models():
+    return render_template(
+        'contributions/spacy_nlp_pipeline_models.html.j2',
+        title='SpaCy NLP Pipeline Models'
+    )
+
+
+@bp.route('/spacy-nlp-pipeline-models/create', methods=['GET', 'POST'])
+def create_spacy_nlp_pipeline_model():
+    form = CreateSpaCyNLPPipelineModelForm(prefix='create-spacy-nlp-pipeline-model-form')
+    if form.is_submitted():
+        if not form.validate():
+            response = {'errors': form.errors}
+            return response, 400
+        try:
+            spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.create(
+                form.spacy_model_file.data,
+                compatible_service_versions=form.compatible_service_versions.data,
+                description=form.description.data,
+                pipeline_name=form.pipeline_name.data,
+                publisher=form.publisher.data,
+                publisher_url=form.publisher_url.data,
+                publishing_url=form.publishing_url.data,
+                publishing_year=form.publishing_year.data,
+                is_public=False,
+                title=form.title.data,
+                version=form.version.data,
+                user=current_user
+            )
+        except OSError:
+            abort(500)
+        db.session.commit()
+        spacy_nlp_pipeline_model_url = url_for(
+            '.spacy_nlp_pipeline_model',
+            spacy_nlp_pipeline_model_id=spacy_nlp_pipeline_model.id
+        )
+        message = Markup(f'SpaCy NLP Pipeline model "<a href="{spacy_nlp_pipeline_model_url}">{spacy_nlp_pipeline_model.title}</a>" created')
+        flash(message)
+        return {}, 201, {'Location': spacy_nlp_pipeline_model_url}
+    return render_template(
+        'contributions/create_spacy_nlp_pipeline_model.html.j2',
+        form=form,
+        title='Create SpaCy NLP Pipeline Model'
+    )
+
+
+@bp.route('/spacy-nlp-pipeline-models/<hashid:spacy_nlp_pipeline_model_id>', methods=['GET', 'POST'])
+def spacy_nlp_pipeline_model(spacy_nlp_pipeline_model_id):
+    spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id)
+    form = EditSpaCyNLPPipelineModelForm(
+        data=spacy_nlp_pipeline_model.to_json_serializeable(),
+        prefix='edit-spacy-nlp-pipeline-model-form'
+    )
+    if form.validate_on_submit():
+        form.populate_obj(spacy_nlp_pipeline_model)
+        if db.session.is_modified(spacy_nlp_pipeline_model):
+            message = Markup(f'SpaCy NLP Pipeline model "<a href="{spacy_nlp_pipeline_model.url}">{spacy_nlp_pipeline_model.title}</a>" updated')
+            flash(message)
+            db.session.commit()
+        return redirect(url_for('.spacy_nlp_pipeline_models'))
+    return render_template(
+        'contributions/spacy_nlp_pipeline_model.html.j2',
+        form=form,
+        spacy_nlp_pipeline_model=spacy_nlp_pipeline_model,
+        title=f'{spacy_nlp_pipeline_model.title} {spacy_nlp_pipeline_model.version}'
+    )
+
+
+@bp.route('/spacy-nlp-pipeline-models/<hashid:spacy_nlp_pipeline_model_id>', methods=['DELETE'])
+def delete_spacy_model(spacy_nlp_pipeline_model_id):
+    def _delete_spacy_model(app, spacy_nlp_pipeline_model_id):
+        with app.app_context():
+            spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get(spacy_nlp_pipeline_model_id)
+            spacy_nlp_pipeline_model.delete()
+            db.session.commit()
+    
+    spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id)
+    if not (spacy_nlp_pipeline_model.user == current_user or current_user.is_administrator()):
+        abort(403)
+    thread = Thread(
+        target=_delete_spacy_model,
+        args=(current_app._get_current_object(), spacy_nlp_pipeline_model_id)
+    )
+    thread.start()
+    return {}, 202
+
+
+#region json-routes
+@bp.route('/spacy-nlp-pipeline-models/<hashid:spacy_nlp_pipeline_model_id>/is_public', methods=['PUT'])
+@login_required
+@permission_required('CONTRIBUTE')
+@content_negotiation(consumes='application/json', produces='application/json')
+def update_spacy_nlp_pipeline_model_is_public(spacy_nlp_pipeline_model_id):
+    is_public = request.json
+    if not isinstance(is_public, bool):
+        response = jsonify('The request body must be a boolean')
+        response.status_code = 400
+        abort(response)
+    spacy_nlp_pipeline_model = \
+        SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id)
+    spacy_nlp_pipeline_model.is_public = is_public
+    db.session.commit()
+    response = jsonify(
+        f'SpaCy NLP Pipeline Model "{spacy_nlp_pipeline_model.title}"'
+        f' is now {"public" if is_public else "private"}'
+    )
+    response.status_code = 200
+    return response
+#endregion json-routes
+#endregion spacy-nlp-pipeline-models
+
+##############################################################################
+# Tesseract OCR Pipeline Models                                              #
+##############################################################################
+#region tesseract-ocr-pipeline-models
 @bp.route('/tesseract-ocr-pipeline-models')
 def tesseract_ocr_pipeline_models():
     return render_template(
@@ -47,6 +165,44 @@ def tesseract_ocr_pipeline_models():
     )
 
 
+@bp.route('/tesseract-ocr-pipeline-models/create', methods=['GET', 'POST'])
+def create_tesseract_ocr_pipeline_model():
+    form = CreateTesseractOCRPipelineModelForm(prefix='create-tesseract-ocr-pipeline-model-form')
+    if form.is_submitted():
+        if not form.validate():
+            response = {'errors': form.errors}
+            return response, 400
+        try:
+            tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.create(
+                form.tesseract_model_file.data,
+                compatible_service_versions=form.compatible_service_versions.data,
+                description=form.description.data,
+                publisher=form.publisher.data,
+                publisher_url=form.publisher_url.data,
+                publishing_url=form.publishing_url.data,
+                publishing_year=form.publishing_year.data,
+                is_public=False,
+                title=form.title.data,
+                version=form.version.data,
+                user=current_user
+            )
+        except OSError:
+            abort(500)
+        db.session.commit()
+        tesseract_ocr_pipeline_model_url = url_for(
+            '.tesseract_ocr_pipeline_model',
+            tesseract_ocr_pipeline_model_id=tesseract_ocr_pipeline_model.id
+        )
+        message = Markup(f'Tesseract OCR Pipeline model "<a href="{tesseract_ocr_pipeline_model_url}">{tesseract_ocr_pipeline_model.title}</a>" created')
+        flash(message)
+        return {}, 201, {'Location': tesseract_ocr_pipeline_model_url}
+    return render_template(
+        'contributions/create_tesseract_ocr_pipeline_model.html.j2',
+        form=form,
+        title='Create Tesseract OCR Pipeline Model'
+    )
+
+
 @bp.route('/tesseract-ocr-pipeline-models/<hashid:tesseract_ocr_pipeline_model_id>', methods=['GET', 'POST'])
 def tesseract_ocr_pipeline_model(tesseract_ocr_pipeline_model_id):
     tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id)
@@ -88,146 +244,26 @@ def delete_tesseract_model(tesseract_ocr_pipeline_model_id):
     return {}, 202
 
 
-@bp.route('/tesseract-ocr-pipeline-models/create', methods=['GET', 'POST'])
+#region json-routes
-def create_tesseract_ocr_pipeline_model():
+@bp.route('/tesseract-ocr-pipeline-models/<hashid:tesseract_ocr_pipeline_model_id>/is_public', methods=['PUT'])
-    form = CreateTesseractOCRPipelineModelForm(prefix='create-tesseract-ocr-pipeline-model-form')
+@login_required
-    if form.is_submitted():
+@permission_required('CONTRIBUTE')
-        if not form.validate():
+@content_negotiation(consumes='application/json', produces='application/json')
-            response = {'errors': form.errors}
+def update_tesseract_ocr_pipeline_model_is_public(tesseract_ocr_pipeline_model_id):
-            return response, 400
+    is_public = request.json
-        try:
+    if not isinstance(is_public, bool):
-            tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.create(
+        response = jsonify('The request body must be a boolean')
-                form.tesseract_model_file.data,
+        response.status_code = 400
-                compatible_service_versions=form.compatible_service_versions.data,
+        abort(response)
-                description=form.description.data,
+    tesseract_ocr_pipeline_model = \
-                publisher=form.publisher.data,
+        TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id)
-                publisher_url=form.publisher_url.data,
+    tesseract_ocr_pipeline_model.is_public = is_public
-                publishing_url=form.publishing_url.data,
-                publishing_year=form.publishing_year.data,
-                is_public=False,
-                title=form.title.data,
-                version=form.version.data,
-                user=current_user
-            )
-        except OSError:
-            abort(500)
-        db.session.commit()
-        tesseract_ocr_pipeline_model_url = url_for(
-            '.tesseract_ocr_pipeline_model',
-            tesseract_ocr_pipeline_model_id=tesseract_ocr_pipeline_model.id
-        )
-        message = Markup(f'Tesseract OCR Pipeline model "<a href="{tesseract_ocr_pipeline_model_url}">{tesseract_ocr_pipeline_model.title}</a>" created')
-        flash(message)
-        return {}, 201, {'Location': tesseract_ocr_pipeline_model_url}
-    return render_template(
-        'contributions/create_tesseract_ocr_pipeline_model.html.j2',
-        form=form,
-        title='Create Tesseract OCR Pipeline Model'
-    )
-
-@bp.route('/tesseract-ocr-pipeline-models/<hashid:tesseract_ocr_pipeline_model_id>/toggle-public-status', methods=['POST'])
-@permission_required(Permission.CONTRIBUTE)
-def toggle_tesseract_ocr_pipeline_model_public_status(tesseract_ocr_pipeline_model_id):
-    tesseract_ocr_pipeline_model = TesseractOCRPipelineModel.query.get_or_404(tesseract_ocr_pipeline_model_id)
-    if not (tesseract_ocr_pipeline_model.user == current_user or current_user.is_administrator()):
-        abort(403)
-    tesseract_ocr_pipeline_model.is_public = not tesseract_ocr_pipeline_model.is_public
     db.session.commit()
-    return {}, 201
+    response = jsonify(
-
+        f'Tesseract OCR Pipeline Model "{tesseract_ocr_pipeline_model.title}"'
-
+        f' is now {"public" if is_public else "private"}'
-@bp.route('/spacy-nlp-pipeline-models')
-def spacy_nlp_pipeline_models():
-    return render_template(
-        'contributions/spacy_nlp_pipeline_models.html.j2',
-        title='SpaCy NLP Pipeline Models'
     )
-
+    response.status_code = 200
-
+    return response
-@bp.route('/spacy-nlp-pipeline-models/<hashid:spacy_nlp_pipeline_model_id>', methods=['GET', 'POST'])
+#endregion json-routes
-def spacy_nlp_pipeline_model(spacy_nlp_pipeline_model_id):
+#endregion tesseract-ocr-pipeline-models
-    spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id)
-    form = EditSpaCyNLPPipelineModelForm(
-        data=spacy_nlp_pipeline_model.to_json_serializeable(),
-        prefix='edit-spacy-nlp-pipeline-model-form'
-    )
-    if form.validate_on_submit():
-        form.populate_obj(spacy_nlp_pipeline_model)
-        if db.session.is_modified(spacy_nlp_pipeline_model):
-            message = Markup(f'SpaCy NLP Pipeline model "<a href="{spacy_nlp_pipeline_model.url}">{spacy_nlp_pipeline_model.title}</a>" updated')
-            flash(message)
-            db.session.commit()
-        return redirect(url_for('.spacy_nlp_pipeline_models'))
-    return render_template(
-        'contributions/spacy_nlp_pipeline_model.html.j2',
-        form=form,
-        spacy_nlp_pipeline_model=spacy_nlp_pipeline_model,
-        title=f'{spacy_nlp_pipeline_model.title} {spacy_nlp_pipeline_model.version}'
-    )
-
-@bp.route('/spacy-nlp-pipeline-models/<hashid:spacy_nlp_pipeline_model_id>', methods=['DELETE'])
-def delete_spacy_model(spacy_nlp_pipeline_model_id):
-    def _delete_spacy_model(app, spacy_nlp_pipeline_model_id):
-        with app.app_context():
-            spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get(spacy_nlp_pipeline_model_id)
-            spacy_nlp_pipeline_model.delete()
-            db.session.commit()
-    
-    spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id)
-    if not (spacy_nlp_pipeline_model.user == current_user or current_user.is_administrator()):
-        abort(403)
-    thread = Thread(
-        target=_delete_spacy_model,
-        args=(current_app._get_current_object(), spacy_nlp_pipeline_model_id)
-    )
-    thread.start()
-    return {}, 202
-
-
-@bp.route('/spacy-nlp-pipeline-models/create', methods=['GET', 'POST'])
-def create_spacy_nlp_pipeline_model():
-    form = CreateSpaCyNLPPipelineModelForm(prefix='create-spacy-nlp-pipeline-model-form')
-    if form.is_submitted():
-        if not form.validate():
-            response = {'errors': form.errors}
-            return response, 400
-        try:
-            spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.create(
-                form.spacy_model_file.data,
-                compatible_service_versions=form.compatible_service_versions.data,
-                description=form.description.data,
-                pipeline_name=form.pipeline_name.data,
-                publisher=form.publisher.data,
-                publisher_url=form.publisher_url.data,
-                publishing_url=form.publishing_url.data,
-                publishing_year=form.publishing_year.data,
-                is_public=False,
-                title=form.title.data,
-                version=form.version.data,
-                user=current_user
-            )
-        except OSError:
-            abort(500)
-        db.session.commit()
-        spacy_nlp_pipeline_model_url = url_for(
-            '.spacy_nlp_pipeline_model',
-            spacy_nlp_pipeline_model_id=spacy_nlp_pipeline_model.id
-        )
-        message = Markup(f'SpaCy NLP Pipeline model "<a href="{spacy_nlp_pipeline_model_url}">{spacy_nlp_pipeline_model.title}</a>" created')
-        flash(message)
-        return {}, 201, {'Location': spacy_nlp_pipeline_model_url}
-    return render_template(
-        'contributions/create_spacy_nlp_pipeline_model.html.j2',
-        form=form,
-        title='Create SpaCy NLP Pipeline Model'
-    )
-
-@bp.route('/spacy-nlp-pipeline-models/<hashid:spacy_nlp_pipeline_model_id>/toggle-public-status', methods=['POST'])
-@permission_required(Permission.CONTRIBUTE)
-def toggle_spacy_nlp_pipeline_model_public_status(spacy_nlp_pipeline_model_id):
-    spacy_nlp_pipeline_model = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id)
-    if not (spacy_nlp_pipeline_model.user == current_user or current_user.is_administrator()):
-        abort(403)
-    spacy_nlp_pipeline_model.is_public = not spacy_nlp_pipeline_model.is_public
-    db.session.commit()
-    return {}, 201