app/api/microlocations.py
from flask_rest_jsonapi import ResourceDetail, ResourceList, ResourceRelationship
from app.api.bootstrap import api
from app.api.helpers.db import safe_query_kwargs
from app.api.helpers.errors import ForbiddenError
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.microlocations import MicrolocationSchema
from app.models import db
from app.models.microlocation import Microlocation
from app.models.session import Session
class MicrolocationListPost(ResourceList):
"""
List and create microlocations
"""
def before_post(self, args, kwargs, data):
"""
before post method to check for required relationship and proper permission
:param args:
:param kwargs:
:param data:
:return:
"""
require_relationship(['event'], data)
if not has_access('is_coorganizer', event_id=data['event']):
raise ForbiddenError({'source': ''}, 'Co-organizer access is required.')
methods = [
'POST',
]
schema = MicrolocationSchema
data_layer = {'session': db.session, 'model': Microlocation}
class MicrolocationList(ResourceList):
"""
List Microlocations
"""
def query(self, view_kwargs):
"""
query method for resource list
:param view_kwargs:
:return:
"""
query_ = self.session.query(Microlocation)
query_ = event_query(query_, view_kwargs)
if view_kwargs.get('session_id'):
session = safe_query_kwargs(Session, view_kwargs, 'session_id')
query_ = query_.join(Session).filter(Session.id == session.id)
elif view_kwargs.get('video_stream_id'):
query_ = query_.filter_by(video_stream_id=view_kwargs['video_stream_id'])
return query_
view_kwargs = True
methods = ['GET']
schema = MicrolocationSchema
data_layer = {
'session': db.session,
'model': Microlocation,
'methods': {'query': query},
}
class MicrolocationDetail(ResourceDetail):
"""
Microlocation detail by id
"""
def before_get_object(self, view_kwargs):
"""
before get method to get the resource id for fetching details
:param view_kwargs:
:return:
"""
if view_kwargs.get('session_id') is not None:
session = safe_query_kwargs(Session, view_kwargs, 'session_id')
if session.microlocation_id is not None:
view_kwargs['id'] = session.microlocation_id
else:
view_kwargs['id'] = None
decorators = (
api.has_permission(
'is_coorganizer',
methods="PATCH,DELETE",
fetch="event_id",
model=Microlocation,
),
)
schema = MicrolocationSchema
data_layer = {
'session': db.session,
'model': Microlocation,
'methods': {'before_get_object': before_get_object},
}
class MicrolocationRelationshipRequired(ResourceRelationship):
"""
Microlocation Relationship for required entities
"""
decorators = (
api.has_permission(
'is_coorganizer',
methods="PATCH",
fetch="event_id",
model=Microlocation,
),
)
methods = ['GET', 'PATCH']
schema = MicrolocationSchema
data_layer = {'session': db.session, 'model': Microlocation}
class MicrolocationRelationshipOptional(ResourceRelationship):
"""
Microlocation Relationship
"""
decorators = (
api.has_permission(
'is_coorganizer',
methods="PATCH,DELETE",
fetch="event_id",
model=Microlocation,
),
)
schema = MicrolocationSchema
data_layer = {'session': db.session, 'model': Microlocation}