fossasia/open-event-orga-server

View on GitHub
app/api/faqs.py

Summary

Maintainability
C
7 hrs
Test Coverage
from flask_rest_jsonapi import ResourceDetail, ResourceList, ResourceRelationship
from flask_rest_jsonapi.exceptions import ObjectNotFound

from app.api.bootstrap import api
from app.api.helpers.db import safe_query_kwargs
from app.api.helpers.permission_manager import has_access
from app.api.helpers.query import event_query
from app.api.helpers.utilities import require_relationship
from app.api.schema.faqs import FaqSchema
from app.models import db
from app.models.faq import Faq
from app.models.faq_type import FaqType


class FaqListPost(ResourceList):
    """
    Create and List FAQs
    """

    def before_post(self, args, kwargs, data):
        """
        method to check for required relationship with event
        :param args:
        :param kwargs:
        :param data:
        :return:
        """
        require_relationship(['event'], data)
        if not has_access('is_coorganizer', event_id=data['event']):
            raise ObjectNotFound(
                {'parameter': 'event_id'}, "Event: {} not found".format(data['event'])
            )

    schema = FaqSchema
    methods = [
        'POST',
    ]
    data_layer = {'session': db.session, 'model': Faq}


class FaqList(ResourceList):
    """
    Show List of FAQs
    """

    def query(self, view_kwargs):
        """
        query method for different view_kwargs
        :param view_kwargs:
        :return:
        """
        query_ = self.session.query(Faq)
        query_ = event_query(query_, view_kwargs)
        if view_kwargs.get('faq_type_id') is not None:
            faq_type = safe_query_kwargs(FaqType, view_kwargs, 'faq_type_id')
            query_ = query_.join(FaqType).filter(FaqType.id == faq_type.id)
        return query_

    view_kwargs = True
    methods = [
        'GET',
    ]
    schema = FaqSchema
    data_layer = {'session': db.session, 'model': Faq, 'methods': {'query': query}}


class FaqDetail(ResourceDetail):
    """
    FAQ Resource
    """

    decorators = (
        api.has_permission(
            'is_coorganizer',
            fetch='event_id',
            model=Faq,
            methods="PATCH,DELETE",
        ),
    )
    schema = FaqSchema
    data_layer = {'session': db.session, 'model': Faq}


class FaqRelationshipRequired(ResourceRelationship):
    """
    FAQ Relationship (Required)
    """

    decorators = (
        api.has_permission(
            'is_coorganizer',
            fetch='event_id',
            model=Faq,
            methods="PATCH",
        ),
    )
    methods = ['GET', 'PATCH']
    schema = FaqSchema
    data_layer = {'session': db.session, 'model': Faq}


class FaqRelationshipOptional(ResourceRelationship):
    """
    FAQ Relationship (Required)
    """

    decorators = (
        api.has_permission(
            'is_coorganizer',
            fetch='event_id',
            model=Faq,
            methods="PATCH",
        ),
    )
    schema = FaqSchema
    data_layer = {'session': db.session, 'model': Faq}