Restructure Contributions with nested blueprints

app/contributions/spacy_nlp_pipeline_models/__init__.py

@@ -0,0 +1,8 @@
+from flask import Blueprint
+
+
+TEMPLATE_FOLDER = 'contributions/spacy_nlp_pipeline_models'
+
+
+bp = Blueprint('spacy_nlp_pipeline_models', __name__)
+from . import routes, json_routes

app/contributions/spacy_nlp_pipeline_models/forms.py

@@ -0,0 +1,44 @@
+from flask_wtf.file import FileField, FileRequired
+from wtforms import StringField, ValidationError
+from wtforms.validators import InputRequired, Length
+from app.services import SERVICES
+from ..forms import ContributionBaseForm, EditContributionBaseForm
+
+
+class CreateSpaCyNLPPipelineModelForm(ContributionBaseForm):
+    spacy_model_file = FileField(
+        'File',
+        validators=[FileRequired()]
+    )
+    pipeline_name = StringField(
+        'Pipeline name',
+        validators=[InputRequired(), Length(max=64)]
+    )
+
+    def validate_spacy_model_file(self, field):
+        if not field.data.filename.lower().endswith('.tar.gz'):
+            raise ValidationError('.tar.gz files only!')
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        service_manifest = SERVICES['spacy-nlp-pipeline']
+        self.compatible_service_versions.choices = [('', 'Choose your option')]
+        self.compatible_service_versions.choices += [
+            (x, x) for x in service_manifest['versions'].keys()
+        ]
+        self.compatible_service_versions.default = ''
+
+
+class EditSpaCyNLPPipelineModelForm(EditContributionBaseForm):
+    pipeline_name = StringField(
+        'Pipeline name',
+        validators=[InputRequired(), Length(max=64)]
+    )
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        service_manifest = SERVICES['spacy-nlp-pipeline']
+        self.compatible_service_versions.choices = [('', 'Choose your option')]
+        self.compatible_service_versions.choices += [
+            (x, x) for x in service_manifest['versions'].keys()
+        ]
+        self.compatible_service_versions.default = ''

app/contributions/spacy_nlp_pipeline_models/json_routes.py

@@ -0,0 +1,58 @@
+from flask import abort, current_app, jsonify, request
+from flask_login import login_required, current_user
+from threading import Thread
+from app import db
+from app.decorators import content_negotiation, permission_required
+from app.models import SpaCyNLPPipelineModel
+from . import bp
+
+
+@bp.route('/<hashid:spacy_nlp_pipeline_model_id>', methods=['DELETE'])
+@login_required
+@content_negotiation(produces='application/json')
+def delete_spacy_model(spacy_nlp_pipeline_model_id):
+    def _delete_spacy_model(app, spacy_nlp_pipeline_model_id):
+        with app.app_context():
+            snpm = SpaCyNLPPipelineModel.query.get(spacy_nlp_pipeline_model_id)
+            snpm.delete()
+            db.session.commit()
+    
+    snpm = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id)
+    if not (snpm.user == current_user or current_user.is_administrator()):
+        abort(403)
+    thread = Thread(
+        target=_delete_spacy_model,
+        args=(current_app._get_current_object(), snpm.id)
+    )
+    thread.start()
+    resonse_data = {
+        'message': \
+            f'SpaCy NLP Pipeline Model "{snpm.title}" marked for deletion'
+    }
+    response = jsonify(resonse_data)
+    response.status_code = 202
+    return response
+
+
+@bp.route('/<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):
+        abort(400)
+    snpm = SpaCyNLPPipelineModel.query.get_or_404(spacy_nlp_pipeline_model_id)
+    if not (snpm.user == current_user or current_user.is_administrator()):
+        abort(403)
+    snpm.is_public = is_public
+    db.session.commit()
+    response_data = {
+        'message': (
+            f'SpaCy NLP Pipeline Model "{snpm.title}"'
+            f' is now {"public" if is_public else "private"}'
+        )
+    }
+    response = jsonify(response_data)
+    response.status_code = 200
+    return response

app/contributions/spacy_nlp_pipeline_models/routes.py

@@ -0,0 +1,87 @@
+from flask import abort, flash, Markup, redirect, render_template, url_for
+from flask_login import login_required, current_user
+from app import db
+from app.models import SpaCyNLPPipelineModel
+from . import bp, TEMPLATE_FOLDER
+from .forms import (
+    CreateSpaCyNLPPipelineModelForm,
+    EditSpaCyNLPPipelineModelForm
+)
+
+
+@bp.route('')
+@login_required
+def spacy_nlp_pipeline_models():
+    return render_template(
+        f'{TEMPLATE_FOLDER}/spacy_nlp_pipeline_models.html.j2',
+        title='SpaCy NLP Pipeline Models'
+    )
+
+
+@bp.route('/create', methods=['GET', 'POST'])
+@login_required
+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 "{spacy_nlp_pipeline_model.title}" '
+            'created'
+        )
+        flash(message)
+        return '', 201, {'Location': spacy_nlp_pipeline_model_url}
+    return render_template(
+        f'{TEMPLATE_FOLDER}/create_spacy_nlp_pipeline_model.html.j2',
+        form=form,
+        title='Create SpaCy NLP Pipeline Model'
+    )
+
+
+@bp.route('/<hashid:spacy_nlp_pipeline_model_id>', methods=['GET', 'POST'])
+@login_required
+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 "{spacy_nlp_pipeline_model.title}" '
+                'updated'
+            )
+            flash(message)
+            db.session.commit()
+        return redirect(url_for('.spacy_nlp_pipeline_models'))
+    return render_template(
+        f'{TEMPLATE_FOLDER}/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}'
+    )