266
app/core/serializers/ticket.py
Normal file
266
app/core/serializers/ticket.py
Normal file
@ -0,0 +1,266 @@
|
||||
from rest_framework import serializers
|
||||
from rest_framework.reverse import reverse
|
||||
|
||||
from drf_spectacular.utils import extend_schema_serializer
|
||||
|
||||
from access.serializers.entity import BaseSerializer as EntityBaseSerializer
|
||||
from access.serializers.organization import OrganizationBaseSerializer
|
||||
|
||||
from api.serializers import common
|
||||
|
||||
from app.serializers.user import UserBaseSerializer
|
||||
|
||||
from core import exceptions as centurion_exception
|
||||
from core import fields as centurion_field
|
||||
from core.fields.badge import BadgeField
|
||||
from core.models.ticket_base import TicketBase
|
||||
from core.serializers.ticket_category import TicketCategoryBaseSerializer
|
||||
|
||||
from project_management.serializers.project import ProjectBaseSerializer
|
||||
from project_management.serializers.project_milestone import ProjectMilestoneBaseSerializer
|
||||
|
||||
|
||||
|
||||
@extend_schema_serializer(component_name = 'TicketBaseBaseSerializer')
|
||||
class BaseSerializer(serializers.ModelSerializer):
|
||||
"""Base Ticket Model"""
|
||||
|
||||
|
||||
display_name = serializers.SerializerMethodField('get_display_name')
|
||||
|
||||
def get_display_name(self, item) -> str:
|
||||
|
||||
return str( item )
|
||||
|
||||
url = serializers.SerializerMethodField('get_url')
|
||||
|
||||
def get_url(self, item) -> str:
|
||||
|
||||
return item.get_url( request = self.context['view'].request )
|
||||
|
||||
|
||||
class Meta:
|
||||
|
||||
model = TicketBase
|
||||
|
||||
fields = [
|
||||
'id',
|
||||
'display_name',
|
||||
'url',
|
||||
]
|
||||
|
||||
read_only_fields = [
|
||||
'id',
|
||||
'display_name',
|
||||
'url',
|
||||
]
|
||||
|
||||
|
||||
|
||||
@extend_schema_serializer(component_name = 'TicketBaseModelSerializer')
|
||||
class ModelSerializer(
|
||||
common.CommonModelSerializer,
|
||||
BaseSerializer
|
||||
):
|
||||
"""Ticket Base Model"""
|
||||
|
||||
|
||||
_urls = serializers.SerializerMethodField('get_url')
|
||||
|
||||
def get_url(self, item) -> dict:
|
||||
|
||||
ticket_type = str(item.ticket_type)
|
||||
|
||||
url_dict: dict = {
|
||||
'_self': item.get_url( request = self._context['view'].request ),
|
||||
'comments': reverse('v2:_api_v2_ticket_comment-list', request=self._context['view'].request, kwargs={'ticket_id': item.pk}),
|
||||
'linked_items': reverse("v2:_api_v2_ticket_linked_item-list", request=self._context['view'].request, kwargs={'ticket_id': item.pk}),
|
||||
}
|
||||
|
||||
if item.project:
|
||||
|
||||
url_dict.update({
|
||||
'project': reverse("v2:_api_v2_project-list", request=self._context['view'].request, kwargs={}),
|
||||
})
|
||||
|
||||
if item.category:
|
||||
|
||||
url_dict.update({
|
||||
'ticketcategory': reverse(
|
||||
'v2:_api_v2_ticket_category-list',
|
||||
request=self._context['view'].request,
|
||||
kwargs={},
|
||||
) + '?' + ticket_type + '=true',
|
||||
})
|
||||
|
||||
|
||||
url_dict.update({
|
||||
'related_tickets': reverse("v2:_api_v2_ticket_related-list", request=self._context['view'].request, kwargs={'ticket_id': item.pk}),
|
||||
})
|
||||
|
||||
|
||||
return url_dict
|
||||
|
||||
description = centurion_field.MarkdownField( required = True, style_class = 'large' )
|
||||
|
||||
impact_badge = BadgeField(label='Impact')
|
||||
|
||||
organization = common.OrganizationField(
|
||||
required = True,
|
||||
write_only = True,
|
||||
)
|
||||
|
||||
priority_badge = BadgeField(
|
||||
label = 'Priority',
|
||||
read_only = True,
|
||||
)
|
||||
|
||||
status_badge = BadgeField(
|
||||
label = 'Status',
|
||||
read_only = True,
|
||||
)
|
||||
|
||||
ticket_duration = serializers.IntegerField(
|
||||
help_text = 'Total time spent on ticket',
|
||||
label = 'Time Spent',
|
||||
read_only = True,
|
||||
)
|
||||
|
||||
ticket_estimation = serializers.IntegerField(
|
||||
help_text = 'Time estimation to complete the ticket',
|
||||
label = 'Time estimation',
|
||||
read_only = True,
|
||||
)
|
||||
|
||||
urgency_badge = BadgeField(
|
||||
label = 'Urgency',
|
||||
read_only = True,
|
||||
)
|
||||
|
||||
|
||||
class Meta:
|
||||
|
||||
model = TicketBase
|
||||
|
||||
fields = [
|
||||
'id',
|
||||
'display_name',
|
||||
'organization',
|
||||
'external_system',
|
||||
'external_ref',
|
||||
'parent_ticket',
|
||||
'ticket_type',
|
||||
'status',
|
||||
'status_badge',
|
||||
'category',
|
||||
'title',
|
||||
'description',
|
||||
'ticket_duration',
|
||||
'ticket_estimation',
|
||||
'project',
|
||||
'milestone',
|
||||
'urgency',
|
||||
'urgency_badge',
|
||||
'impact',
|
||||
'impact_badge',
|
||||
'priority',
|
||||
'priority_badge',
|
||||
'opened_by',
|
||||
'subscribed_to',
|
||||
'assigned_to',
|
||||
'planned_start_date',
|
||||
'planned_finish_date',
|
||||
'real_start_date',
|
||||
'real_finish_date',
|
||||
'is_deleted',
|
||||
'is_solved',
|
||||
'date_solved',
|
||||
'is_closed',
|
||||
'date_closed',
|
||||
'created',
|
||||
'modified',
|
||||
'_urls',
|
||||
]
|
||||
|
||||
read_only_fields = [
|
||||
'id',
|
||||
'display_name',
|
||||
'external_system',
|
||||
'external_ref',
|
||||
'ticket_type',
|
||||
'created',
|
||||
'modified',
|
||||
'_urls',
|
||||
]
|
||||
|
||||
|
||||
|
||||
def validate_field_milestone( self ) -> bool:
|
||||
|
||||
is_valid: bool = False
|
||||
|
||||
if self.instance is not None:
|
||||
|
||||
if self.instance.milestone is None:
|
||||
|
||||
return True
|
||||
|
||||
else:
|
||||
|
||||
if self.instance.project is None:
|
||||
|
||||
raise centurion_exception.ValidationError(
|
||||
details = 'Milestones require a project',
|
||||
code = 'milestone_requires_project',
|
||||
)
|
||||
|
||||
return False
|
||||
|
||||
if self.instance.project.id == self.instance.milestone.project.id:
|
||||
|
||||
return True
|
||||
|
||||
else:
|
||||
|
||||
raise centurion_exception.ValidationError(
|
||||
detail = 'Milestone must be from the same project',
|
||||
code = 'milestone_same_project',
|
||||
)
|
||||
|
||||
return is_valid
|
||||
|
||||
|
||||
|
||||
def validate(self, attrs):
|
||||
|
||||
attrs = super().validate(attrs)
|
||||
|
||||
if not self.validate_field_milestone:
|
||||
|
||||
del attrs['milestone']
|
||||
|
||||
|
||||
return attrs
|
||||
|
||||
|
||||
|
||||
|
||||
@extend_schema_serializer(component_name = 'TicketBaseViewSerializer')
|
||||
class ViewSerializer(ModelSerializer):
|
||||
"""Ticket Base View Model"""
|
||||
|
||||
assigned_to = EntityBaseSerializer(many=True, label = 'assigned to')
|
||||
|
||||
category = TicketCategoryBaseSerializer(label = 'category')
|
||||
|
||||
milestone = ProjectMilestoneBaseSerializer(many=False, read_only=True)
|
||||
|
||||
opened_by = UserBaseSerializer()
|
||||
|
||||
organization = OrganizationBaseSerializer(many=False, read_only=True)
|
||||
|
||||
parent_ticket = BaseSerializer()
|
||||
|
||||
project = ProjectBaseSerializer(many=False, read_only=True)
|
||||
|
||||
subscribed_to = EntityBaseSerializer(many=True, label = 'subscribved to')
|
||||
Reference in New Issue
Block a user