deandrebaker
commented
3 years ago Abstract API Views
- AbstractModelViewSet uses the detailed or regular serializer class when it's supposed to.
- AbstractAddRemoveUser gets a list of objects from the attribute on a user specified by queryset.
- AbstractAddRemoveUser uses the detailed or regular serializer class when it's supposed to.
- AbstractAddRemoveUser can add an object to the list of objects using the attribute specified by queryset.
- AbstractAddRemoveUser can remove an object from the list of objects using the attribute specified by queryset.
- AbstractAddRemoveUser sends a liked user notification when the user likes a shared item.
- AbstractAddRemoveUser throws an exception if request data is invalid.
- AbstractAddRemoveUser throws an exception if the shared item does not exist.
- AbstractLikedUsers (name may change) gets a list of users from the attribute on an object specified by queryset.
Abstract models
- IsCreatorOrReadOnly only allows the creator of a shared item to modify or delete it.
- IsCreator only allows the creator of a shared item to access it.
Abstract serializers
- AbstractSharedItemSerializer.get_is_liked() returns true if and only if the user has liked the shared item.
- AbstractSharedItemSerializer.get_is_saved() returns true if and only if the user has saved the shared item.
- AbstractSharedItemSerializer.get_likes() returns the number of liked users for a shared item.
- AbstractPostSerializer.get_comments() returns the number of comments for a shared item.
- AbstractModelSerializer sends tagged users notification when a user creates a shared item with tagged users.
- AbstractCreatorSerializer assigns the user as the creator of the shared item during creation.
Decorators
- model_view_set_swagger_decorator() applies the swagger_auto_schema decorator to all methods in a model view set class.
- api_view_swagger_decorator applies() the swagger_auto_schema decorator to get and post methods in an API view class.
Model extensions
- PhotoCollectionExtension deletes all photos from the filesystem when an object is deleted.
Notification helpers
- create_tagged_users_notification() sends push notifications to all tagged users for a shared item.
- create_connection_request_notification() sends push notification to the receiver of a connection request/acceptance.
- create_message_notification() sends push notifications to the receivers of a message.
- create_liked_shared_item_notification() sends push notification to the owner of the liked shared item.
- send_push_notifications() sends push notifications to all receivers.
Seriazlier extentions
- ModelSerializerExtension adds the extra_fields fields
- ModelSerializerExtension removes the exclude_fields fields
Event models
- Event only creates events with valid locations.
Event serializers
- EventSerializer.get_is_interested() returns true if and only if the user is interested in the event.
- EventSerializer.get_is_attending() returns true if and only if the user is attending in the event.
- EventSerializer.get_interested() returns the number of users interested in an event.
- EventSerializer.get_attending() returns the number of users attending in an event.
Messaging API views
- RoomViewSet shows only the rooms that the user is a member of.
- AddRemoveMembers can add a member to the rooms.
- AddRemoveMembers shows that the user is already a member.
- AddRemoveMembers can remove a member from the rooms.
- AddRemoveMembers returns 400 if the user to add is not found.
- AddRemoveMembers returns 404 if the room is not found (for both post and delete).
- MessageList gets a list of messages after the time the user joined the room.
- MessageList returns 403 if the user is not a member of the room.
- MessageList returns 404 if the room is not found.
Messaging models
- Room is deleted if there are no more members.
- IsMember allows members of a room to access it.
- ondelete_shared_item() Removes a reference to a deleted shared item from a message and set the reference to null.
Messaging receiver
- receive_message() creates a message event.
- receive_message() creates a message event with a reference to a shared item.
- receive_message() creates a message event with a previous message.
- receive_like() creates a like event.
- receive_like() creates an unlike event.
Messaging serializers
- RoomSerializer adds the user to the list of members when creating a room.
Notification API views
- NotificationList shows a list of all notifications both received and viewed.
- NotificationList removes a user from the list of receivers and adds them to the list of viewers.
- DeviceViewSet shows a list of all devices for the user.
Photo models
- CustomManager delets all photos in self.get_queryset().
- Photo deletes the old image from the file system when replaced with a new one.
- Photo deletes the image from the file system when the photo object is being deleted.
- Photo does not throw an exception when there is no old image and photo is being updated.
- Photo does not throw an exception when there is no old image and photo is being destroyed.
Users models
- CustomUserManager only creates users that have a uwaterloo.ca email with the exception of teamumigrate@gmail.com
- CustomUser deletes the old profile and background photos from the file system when replaced with a new one.
- CustomUser deletes the old profile and background photos from the file system when the user is being deleted.
- CustomUser does not throw an exception when there are no old profile and background photos and user is being updated.
- CustomUser does not throw an exception when there are no old profile and background photos and user is being destroyed.
User serializers
- BasicUserSerializer.get_connection_status() shows the correct connection status between users
- BasicUserSerializer.get_is_blocked() shows the blocked status of a user.
Registration views
- bunch of stuff (todo)
We have integration tests for most of our basic API endpoints. However, many of these tests are redundant since most basic API endpoints behave similarly (they inherit from the same parent class and have the same logic).
We aren't unit testing any custom logic in our code. We should add unit tests for classes and functions that have logic we wrote.
We may need to use dependency injection in some scenarios to make it easier to mock dependencies (such as notification helpers).