Add API blueprints for user favourite events

app/factories/user_favourite_events.py

@@ -0,0 +1,14 @@
+import factory
+
+from app.factories.user import UserFactory
+from app.factories.event import EventFactoryBasic
+from app.models.user_favourite_event import db, UserFavouriteEvent
+
+
+class UserFavouriteEventFactory(factory.alchemy.SQLAlchemyModelFactory):
+    class Meta:
+        model = UserFavouriteEvent
+        sqlalchemy_session = db.session
+
+    user = factory.RelatedFactory(UserFactory)
+    event = factory.RelatedFactory(EventFactoryBasic)

docs/api/api_blueprint.apib

@@ -25337,3 +25337,183 @@ Get the details of the panel permission.
                 "version": "1.0"
             }
         }
+
+# Group Favourite Events
+
+This Group's APIs can be used for adding a particular event to the favourite list of the user.
+
+## Favourite Events Collection [/v1/user-favourite-events]
+
+### List All Favourite Events [GET]
+
++ Request
+
+    + Headers
+
+            Authorization: JWT <Auth Key>
+
++ Response 200 (application/vnd.api+json)
+
+        {
+            "data": [
+                {
+                    "type": "user-favourite-event",
+                    "id": "1",
+                    "relationships": {
+                        "event": {
+                            "links": {
+                                "self": "/v1/user-favourite-events/1/relationships/event",
+                                "related": "/v1/user-favourite-events/1/event"
+                            }
+                        },
+                        "user": {
+                            "links": {
+                                "self": "/v1/user-favourite-events/1/relationships/user",
+                                "related": "/v1/favourite-events/1/user"
+                            }
+                        }
+                    },
+                    "attributes": {
+                        "deleted-at": null
+                    },
+                    "links": {
+                        "self": "/v1/user-favourite-events/1"
+                    }
+                }
+            ],
+            "links": {
+                "self": "/v1/user-favourite-events"
+            },
+            "meta": {
+                "count": 1
+            },
+            "jsonapi": {
+                "version": "1.0"
+            }
+        }
+
+### Create a Favourite Event [POST]
+
++ Request
+
+    + Headers
+
+            Authorization: JWT <Auth Key>
+            Content-Type: application/vnd.api+json
+
+    + Body
+
+            {
+                "data": {
+                    "type": "user-favourite-event",
+                    "relationships": {
+                        "event": {
+                            "data": {
+                                "id": "1",
+                                "type": "event"
+                            }
+                        }
+                    }
+                }
+            }
+
++ Response 201 (application/vnd.api+json)
+
+        {
+            "data": {
+                "type": "user-favourite-event",
+                "relationships": {
+                    "user": {
+                        "links": {
+                            "self": "/v1/user-favourite-events/1/relationships/user",
+                            "related": "/v1/favourite-events/1/user"
+                        }
+                    },
+                    "event": {
+                        "links": {
+                            "self": "/v1/user-favourite-events/1/relationships/event",
+                            "related": "/v1/user-favourite-events/1/event"
+                        }
+                    }
+                },
+                "attributes": {
+                    "deleted-at": null
+                },
+                "id": "1",
+                "links": {
+                    "self": "/v1/user-favourite-events/1"
+                }
+            },
+            "links": {
+                "self": "/v1/user-favourite-events/1"
+            },
+            "jsonapi": {
+                "version": "1.0"
+            }
+        }
+
+## Favourite Events Detail [/v1/user-favourite-events/{user_favourite_event_id}]
++ Parameters
+    + user_favourite_event_id: 1 (integer) - ID of the Favourite Event
+
+### Get Details [GET]
+
++ Request
+
+    + Headers
+
+            Authorization: JWT <Auth Key>
+
++ Response 200 (application/vnd.api+json)
+
+        {
+            "links": {
+                "self": "/v1/user-favourite-events/1"
+            },
+            "jsonapi": {
+                "version": "1.0"
+            },
+            "data": {
+                "type": "user-favourite-event",
+                "links": {
+                    "self": "/v1/user-favourite-events/1"
+                },
+                "id": "1",
+                "attributes": {
+                    "deleted-at": null
+                },
+                "relationships": {
+                    "user": {
+                        "links": {
+                            "related": "/v1/favourite-events/1/user",
+                            "self": "/v1/user-favourite-events/1/relationships/user"
+                        }
+                    },
+                    "event": {
+                        "links": {
+                            "related": "/v1/user-favourite-events/1/event",
+                            "self": "/v1/user-favourite-events/1/relationships/event"
+                        }
+                    }
+                }
+            }
+        }
+
+### Delete Favourite Event [DELETE]
+
++ Request
+
+    + Headers
+
+            Authorization: JWT <Auth Key>
+
++ Response 200 (application/vnd.api+json)
+
+        {
+            "meta": {
+                "message": "Object successfully deleted"
+            },
+            "jsonapi": {
+                "version": "1.0"
+            }
+        }

tests/hook_main.py

@@ -62,6 +62,7 @@
 from app.factories.feedback import FeedbackFactory
 from app.factories.service import ServiceFactory
 from app.factories.message_setting import MessageSettingsFactory
+from app.factories.user_favourite_events import UserFavouriteEventFactory
 
 
 
@@ -4353,3 +4354,56 @@ def panel_permissions_custom_system_role(transaction):
         panel_permission = PanelPermissionFactory()
         db.session.add(panel_permission)
         db.session.commit()
+
+# ------------------------- User Favourite Events -------------------------
+
+@hooks.before("Favourite Events > Favourite Events Collection > List All Favourite Events")
+def favourite_events_list_get(transaction):
+    """
+    GET /user-favourite-events
+    :param transaction:
+    :return:
+    """
+    with stash['app'].app_context():
+        user_fav_event = UserFavouriteEventFactory()
+        db.session.add(user_fav_event)
+        db.session.commit()
+
+
+@hooks.before("Favourite Events > Favourite Events Collection > Create a Favourite Event")
+def favourite_events_list_post(transaction):
+    """
+    POST /user-favourite-events
+    :param transaction:
+    :return:
+    """
+    with stash['app'].app_context():
+        user_fav_event = UserFavouriteEventFactory()
+        db.session.add(user_fav_event)
+        db.session.commit()
+
+
+@hooks.before("Favourite Events > Favourite Events Detail > Get Details")
+def favourite_event_details_get(transaction):
+    """
+    GET /user-favourite-events/1
+    :param transaction:
+    :return:
+    """
+    with stash['app'].app_context():
+        user_fav_event = UserFavouriteEventFactory()
+        db.session.add(user_fav_event)
+        db.session.commit()
+
+
+@hooks.before("Favourite Events > Favourite Events Detail > Delete Favourite Event")
+def favourite_event_delete(transaction):
+    """
+    DELETE /user-favourite-events/1
+    :param transaction:
+    :return:
+    """
+    with stash['app'].app_context():
+        user_fav_event = UserFavouriteEventFactory()
+        db.session.add(user_fav_event)
+        db.session.commit()