feature-8684: Add option to tag attendees (#9072)

* feature-8684: Add option to tag attendees

* feature-8684: Merge code development

* feature-8684: Add option to tag attendees

* feature-8684: Add option to tag attendees

* feature-8684: Add option to tag attendees

* feature-8684: Add option to tag attendees

* feature-8684: Add option to tag attendees

Author: Hieu Lam - TMA

app/api/routes.py

@@ -241,6 +241,7 @@
     StripeAuthorizationListPost,
     StripeAuthorizationRelationship,
 )
+from app.api.tags import TagDetail, TagList, TagListPost, TagRelationship
 from app.api.tax import TaxDetail, TaxList, TaxRelationship
 from app.api.ticket_fees import TicketFeeDetail, TicketFeeList
 from app.api.ticket_tags import (
@@ -840,6 +841,7 @@
     '/speaker-invites/<int:speaker_invite_id>/event',
     '/stations/<int:station_id>/event',
     '/badge-forms/<int:badge_form_id>/event',
+    '/tags/<int:tag_id>/event',
 )
 api.route(
     EventRelationship,
@@ -1021,6 +1023,12 @@
     '/events/<int:id>/relationships/group',
     '/events/<identifier>/relationships/group',
 )
+api.route(
+    EventRelationship,
+    'event_tags',
+    '/events/<int:id>/relationships/tags',
+    '/events/<identifier>/relationships/tags',
+)
 # Events -> roles:
 api.route(
     EventRelationship,
@@ -1530,6 +1538,11 @@
     'attendee_user',
     '/attendees/<int:id>/relationships/user',
 )
+api.route(
+    AttendeeRelationshipOptional,
+    'attendee_tag',
+    '/attendees/<int:id>/relationships/tag',
+)
 
 # event locations
 api.route(EventLocationList, 'event_location_list', '/event-locations')
@@ -2198,3 +2211,13 @@
     'badge_field_form_badge_form',
     '/badge-field-forms/<int:id>/relationships/badge_form',
 )
+
+api.route(TagListPost, 'tag_post', '/tags')
+api.route(TagList, 'tags_list', '/events/<int:event_id>/tags')
+api.route(
+    TagDetail,
+    'tags_detail',
+    '/tags/<int:id>',
+    '/attendees/<int:attendee_id>/tags',
+)
+api.route(TagRelationship, 'tags_event', '/tags/<int:id>/relationships/event')

app/api/schema/attendees.py

@@ -82,6 +82,7 @@ def validate_json(self, data, original_data):
     is_consent_form_field_email = fields.Boolean(allow_none=True)
     is_badge_printed = fields.Boolean(allow_none=True)
     badge_printed_at = fields.DateTime(allow_none=True)
+    tag_id = fields.Int(allow_none=True)
     event = Relationship(
         self_view='v1.attendee_event',
         self_view_kwargs={'id': '<id>'},
@@ -109,6 +110,14 @@ def validate_json(self, data, original_data):
         type_='ticket',
         dump_only=True,
     )
+    tag = Relationship(
+        self_view='v1.attendee_tag',
+        self_view_kwargs={'id': '<id>'},
+        related_view='v1.tags_detail',
+        related_view_kwargs={'attendee_id': '<id>'},
+        schema='TagSchema',
+        type_='tag',
+    )
 
 
 class AttendeeSchema(AttendeeSchemaPublic):

app/api/schema/events.py

@@ -404,6 +404,16 @@ def validate_timezone(self, data, original_data):
         many=True,
         type_='badge-form',
     )
+    tags = Relationship(
+        attribute='tag',
+        self_view='v1.event_tags',
+        self_view_kwargs={'id': '<id>'},
+        related_view='v1.tags_list',
+        related_view_kwargs={'event_id': '<id>'},
+        schema='TagSchema',
+        many=True,
+        type_='tag',
+    )
 
 
 class EventSchema(EventSchemaPublic):

app/api/schema/tag.py

@@ -0,0 +1,30 @@
+from marshmallow_jsonapi import fields
+from marshmallow_jsonapi.flask import Relationship
+
+from app.api.helpers.utilities import dasherize
+from app.api.schema.base import SoftDeletionSchema
+
+
+class TagSchema(SoftDeletionSchema):
+    """API Schema for user tag Model"""
+
+    class Meta:
+        """Meta class for user tag API schema"""
+
+        type_ = 'tag'
+        self_view = 'v1.tags_detail'
+        self_view_kwargs = {'id': '<id>'}
+        inflect = dasherize
+
+    id = fields.Str(dump_only=True)
+    name = fields.Str(required=True)
+    color = fields.Str(allow_none=True)
+    is_read_only = fields.Boolean(required=False)
+    event = Relationship(
+        self_view='v1.tags_event',
+        self_view_kwargs={'id': '<id>'},
+        related_view='v1.event_detail',
+        related_view_kwargs={'tag_id': '<id>'},
+        schema='EventSchema',
+        type_='event',
+    )

app/api/tags.py

@@ -0,0 +1,128 @@
+from flask_rest_jsonapi import ResourceDetail, ResourceList, ResourceRelationship
+
+from app.api.helpers.db import get_count, safe_query_kwargs
+from app.api.helpers.errors import ConflictError
+from app.api.helpers.utilities import require_relationship
+from app.api.schema.tag import TagSchema
+from app.models import db
+from app.models.event import Event
+from app.models.tag import Tag
+from app.models.ticket_holder import TicketHolder
+
+
+class TagList(ResourceList):
+    """List User Emails for a user"""
+
+    def query(self, view_kwargs):
+        """
+        query method for Notifications list
+        :param view_kwargs:
+        :return:
+        """
+        query_ = self.session.query(Tag)
+        if view_kwargs.get('event_id'):
+            event = safe_query_kwargs(Event, view_kwargs, 'event_id')
+            query_ = (
+                query_.join(Event).filter(Event.id == event.id).order_by(Tag.id.asc())
+            )
+        return query_
+
+    view_kwargs = True
+    methods = [
+        "GET",
+    ]
+    schema = TagSchema
+    data_layer = {'session': db.session, 'model': Tag, 'methods': {'query': query}}
+
+
+class TagListPost(ResourceList):
+    """Create new alternate email for a user"""
+
+    @staticmethod
+    def before_post(_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 (
+            get_count(
+                db.session.query(Tag.id).filter_by(
+                    name=data.get('name'),
+                    event_id=int(data['event']),
+                    deleted_at=None,
+                )
+            )
+            > 0
+        ):
+            raise ConflictError(
+                {'pointer': '/data/attributes/name'}, "Name already exists"
+            )
+
+    schema = TagSchema
+    methods = [
+        'POST',
+    ]
+    data_layer = {
+        'session': db.session,
+        'model': Tag,
+        'methods': {'before_post': before_post},
+    }
+
+
+class TagDetail(ResourceDetail):
+    """User Email detail by id"""
+
+    @staticmethod
+    def before_patch(_obj, _kwargs, data):
+        """
+        before patch method to check for required relationship and proper permission
+        :param args:
+        :param kwargs:
+        :param data:
+        :return:
+        """
+        require_relationship(['event'], data)
+        tag = (
+            db.session.query(Tag)
+            .filter_by(
+                name=data.get('name'), event_id=int(data['event']), deleted_at=None
+            )
+            .first()
+        )
+        if tag and tag.is_read_only and tag.name != data.get('name'):
+            raise ConflictError(
+                {'pointer': '/data/attributes/is_read_only'},
+                "Cannot update read-only tag",
+            )
+
+    @staticmethod
+    def before_delete(_obj, kwargs):
+        """
+        before delete method to check for required relationship and proper permission
+        :param args:
+        :param kwargs:
+        :param data:
+        :return:
+        """
+        ticketHolders = TicketHolder.query.filter_by(tag_id=kwargs['id']).all()
+        for item in ticketHolders:
+            item.tag_id = None
+            db.session.add(item)
+
+    schema = TagSchema
+    data_layer = {
+        'session': db.session,
+        'model': Tag,
+        'methods': {'before_delete': before_delete, before_patch: 'before_patch'},
+    }
+
+
+class TagRelationship(ResourceRelationship):
+    """User Email Relationship"""
+
+    schema = TagSchema
+    data_layer = {'session': db.session, 'model': Tag}

app/models/tag.py

@@ -0,0 +1,17 @@
+from app.models import db
+from app.models.base import SoftDeletionModel
+
+
+class Tag(SoftDeletionModel):
+    """Tag model class"""
+
+    __tablename__ = 'tags'
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String, nullable=False)
+    color = db.Column(db.String)
+    is_read_only = db.Column(db.Boolean, nullable=False, default=False)
+    event_id = db.Column(db.Integer, db.ForeignKey('events.id', ondelete='CASCADE'))
+    event = db.relationship("Event", backref="tags_", foreign_keys=[event_id])
+
+    def __repr__(self):
+        return f'<Tag {self.id!r}>'

app/models/ticket_holder.py

@@ -86,6 +86,8 @@ class TicketHolder(SoftDeletionModel):
     is_consent_form_field_email: bool = db.Column(db.Boolean, default=False)
     is_badge_printed: bool = db.Column(db.Boolean, default=False)
     badge_printed_at: datetime = db.Column(db.DateTime(timezone=True))
+    tag_id: int = db.Column(db.Integer, db.ForeignKey('tags.id', ondelete='CASCADE'))
+    tag = db.relationship('Tag', backref='ticket_holders')
 
     @property
     def name(self):

migrations/versions/rev-2023-08-11-15:26:07-1af4cc4f7cd5_.py

@@ -0,0 +1,40 @@
+"""empty message
+
+Revision ID: 1af4cc4f7cd5
+Revises: 24271525a263
+Create Date: 2023-08-11 15:26:07.373388
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '1af4cc4f7cd5'
+down_revision = '24271525a263'
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('tags',
+    sa.Column('deleted_at', sa.DateTime(timezone=True), nullable=True),
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('name', sa.String(), nullable=False),
+    sa.Column('color', sa.String(), nullable=True),
+    sa.Column('is_read_only', sa.Boolean(), nullable=False),
+    sa.Column('event_id', sa.Integer(), nullable=True),
+    sa.ForeignKeyConstraint(['event_id'], ['events.id'], ondelete='CASCADE'),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.add_column('ticket_holders', sa.Column('tag_id', sa.Integer(), nullable=True))
+    op.create_foreign_key(u'ticket_holders_tag_id_fkey', 'ticket_holders', 'tags', ['tag_id'], ['id'], ondelete='CASCADE')
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(u'ticket_holders_tag_id_fkey', 'ticket_holders', type_='foreignkey')
+    op.drop_column('ticket_holders', 'tag_id')
+    op.drop_table('tags')
+    # ### end Alembic commands ###