zou 0.19.15__py3-none-any.whl → 0.20.11__py3-none-any.whl

zou/app/blueprints/chats/__init__.py

@@ -0,0 +1,22 @@
+from flask import Blueprint
+
+from zou.app.utils.api import configure_api_from_blueprint
+
+from zou.app.blueprints.chats.resources import (
+    ChatResource,
+    ChatMessagesResource,
+    ChatMessageResource,
+)
+
+
+routes = [
+    ("/data/entities/<entity_id>/chat", ChatResource),
+    ("/data/entities/<entity_id>/chat/messages", ChatMessagesResource),
+    (
+        "/data/entities/<entity_id>/chat/messages/<chat_message_id>",
+        ChatMessageResource,
+    ),
+]
+
+blueprint = Blueprint("chats", "chats")
+api = configure_api_from_blueprint(blueprint, routes)

zou/app/blueprints/chats/resources.py

@@ -0,0 +1,199 @@
+from flask import request
+from flask_restful import Resource, reqparse
+from flask_jwt_extended import jwt_required
+
+from zou.app.utils import permissions
+
+from zou.app.services import (
+    chats_service,
+    entities_service,
+    persons_service,
+    user_service,
+)
+from zou.app.services.exception import WrongParameterException
+
+
+class ChatResource(Resource):
+
+    @jwt_required()
+    def get(self, entity_id):
+        """
+        Get chat details.
+        ---
+        tags:
+          - Chat
+        parameters:
+          - in: path
+            name: entity_id
+            description: ID of the entity related to the chat
+            type: integer
+            required: true
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+          200:
+            description: Chat information
+        """
+        entity = entities_service.get_entity(entity_id)
+        user_service.check_project_access(entity["project_id"])
+        user_service.check_entity_access(entity["id"])
+        chat = chats_service.get_chat(entity_id)
+        chat["messages"] = chats_service.get_chat_messages(entity_id)
+        return chat
+
+
+class ChatMessagesResource(Resource):
+
+    @jwt_required()
+    def get(self, entity_id):
+        """
+        Get chat messages for an entity.
+        ---
+        tags:
+          - Chat
+        parameters:
+          - in: path
+            name: entity_id
+            description: ID of the entity related to the chat
+            type: integer
+            required: true
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            200:
+                description: Chat messages
+        """
+        entity = entities_service.get_entity(entity_id)
+        user_service.check_project_access(entity["project_id"])
+        user_service.check_entity_access(entity["id"])
+        return chats_service.get_chat_messages_for_entity(entity_id)
+
+    @jwt_required()
+    def post(self, entity_id):
+        """
+        Create a new chat message.
+        ---
+        tags:
+          - Chat
+        parameters:
+          - in: path
+            name: entity_id
+            description: ID of the entity related to the chat
+            type: integer
+            required: true
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: body
+            name: message
+            description: Message to send
+            type: string
+            required: true
+            x-example: Hello, world!
+          - in: formData
+            name: files
+            description: Files to attach
+            type: file
+            required: false
+        responses:
+            201:
+                description: Chat message created
+            400:
+                description: Not participant of the chat
+        """
+        entity = entities_service.get_entity(entity_id)
+        user_service.check_project_access(entity["project_id"])
+        user_service.check_entity_access(entity["id"])
+
+        person = persons_service.get_current_user()
+        if request.is_json:
+            location = ["values", "json"]
+        else:
+            location = ["values", "form"]
+        parser = reqparse.RequestParser()
+        parser.add_argument(
+            "message", type=str, required=True, location=location
+        )
+        args = parser.parse_args()
+        message = args["message"]
+        files = request.files
+
+        chat = chats_service.get_chat(entity_id)
+        if person["id"] not in chat["participants"]:
+            raise WrongParameterException(
+                "You are not a participant of this chat"
+            )
+
+        return (
+            chats_service.create_chat_message(
+                chat["id"], person["id"], message, files=files
+            ),
+            201,
+        )
+
+
+class ChatMessageResource(Resource):
+
+    @jwt_required()
+    def get(self, entity_id, chat_message_id):
+        """
+        Get chat message.
+        ---
+        tags:
+          - Chat
+        parameters:
+          - in: path
+            name: entity_id
+            description: ID of the entity related to the chat
+            type: integer
+            required: true
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: chat_message_id
+            description: ID of the chat message
+            type: integer
+            required: true
+            x-example: 1
+        responses:
+            200:
+                description: Chat message
+        """
+        entity = entities_service.get_entity(entity_id)
+        user_service.check_project_access(entity["project_id"])
+        user_service.check_entity_access(entity["id"])
+        return chats_service.get_chat_message(chat_message_id)
+
+    @jwt_required()
+    def delete(self, entity_id, chat_message_id):
+        """
+        Delete chat message.
+        ---
+        tags:
+          - Chat
+        parameters:
+          - in: path
+            name: entity_id
+            description: ID of the entity related to the chat
+            type: integer
+            required: true
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: chat_message_id
+            description: ID of the chat message
+            type: integer
+            required: true
+            x-example: 1
+        responses:
+            204:
+                description: Empty response
+        """
+        entity = entities_service.get_entity(entity_id)
+        user_service.check_project_access(entity["project_id"])
+        user_service.check_entity_access(entity["id"])
+
+        chat_message = chats_service.get_chat_message(chat_message_id)
+        current_user = persons_service.get_current_user()
+        if (
+            chat_message["person_id"] != current_user["id"]
+            or not permissions.has_admin_permissions
+        ):
+            raise permissions.PermissionDenied
+        chats_service.delete_chat_message(chat_message_id)
+
+        return "", 204

zou/app/blueprints/comments/resources.py

@@ -5,11 +5,13 @@ from flask_restful import Resource, reqparse
 from flask_jwt_extended import jwt_required
 
 from zou.app.mixin import ArgsMixin
-from zou.app.utils import permissions
+from zou.app.utils import permissions, date_helpers
 
 from zou.app.services import (
+    chats_service,
     comments_service,
     deletion_service,
+    entities_service,
     persons_service,
     tasks_service,
     user_service,
@@ -53,10 +55,18 @@ class DownloadAttachmentResource(Resource):
         attachment_file = comments_service.get_attachment_file(
             attachment_file_id
         )
-        comment = tasks_service.get_comment(attachment_file["comment_id"])
-        task = tasks_service.get_task(comment["object_id"])
-        user_service.check_project_access(task["project_id"])
-        user_service.check_entity_access(task["entity_id"])
+        if attachment_file["comment_id"] is not None:
+            comment = tasks_service.get_comment(attachment_file["comment_id"])
+            user_service.check_task_access(comment["object_id"])
+        elif attachment_file["chat_message_id"] is not None:
+            message = chats_service.get_chat_message(
+                attachment_file["chat_message_id"]
+            )
+            chat = chats_service.get_chat_by_id(message["chat_id"])
+            entity = entities_service.get_entity(chat["object_id"])
+            user_service.check_project_access(entity["project_id"])
+        else:
+            raise permissions.PermissionDenied()
         try:
             file_path = comments_service.get_attachment_file_path(
                 attachment_file
@@ -68,6 +78,9 @@ class DownloadAttachmentResource(Resource):
                 as_attachment=False,
                 download_name=attachment_file["name"],
                 max_age=config.CLIENT_CACHE_MAX_AGE,
+                last_modified=date_helpers.get_datetime_from_string(
+                    attachment_file["updated_at"]
+                ),
             )
         except Exception:
             current_app.logger.error(
@@ -107,9 +120,7 @@ class AckCommentResource(Resource):
             200:
                 description: Comment acknowledged
         """
-        task = tasks_service.get_task(task_id)
-        user_service.check_project_access(task["project_id"])
-        user_service.check_entity_access(task["entity_id"])
+        user_service.check_task_access(task_id)
         return comments_service.acknowledge_comment(comment_id)
 
 
@@ -175,11 +186,10 @@ class CommentTaskResource(Resource):
             person_id,
             created_at,
             checklist,
+            links,
         ) = self.get_arguments()
 
-        task = tasks_service.get_task(task_id)
-        user_service.check_project_access(task["project_id"])
-        user_service.check_entity_access(task["entity_id"])
+        user_service.check_task_access(task_id)
         user_service.check_task_status_access(task_status_id)
         files = request.files
 
@@ -194,6 +204,7 @@ class CommentTaskResource(Resource):
             checklist,
             files,
             created_at,
+            links,
         )
         return comment, 201
 
@@ -208,9 +219,17 @@ class CommentTaskResource(Resource):
                 default=[],
                 location=location,
             )
+            parser.add_argument(
+                "links",
+                type=str,
+                action="append",
+                default=[],
+                location=location,
+            )
         else:
             location = "values"
             parser.add_argument("checklist", default="[]", location=location)
+            parser.add_argument("links", default="[]", location=location)
         parser.add_argument(
             "task_status_id",
             required=True,
@@ -231,6 +250,7 @@ class CommentTaskResource(Resource):
                 if request.is_json
                 else json.loads(args["checklist"])
             ),
+            (args["links"] if request.is_json else json.loads(args["links"])),
         )
 
 
@@ -398,6 +418,7 @@ class CommentManyTasksResource(Resource):
                     [],
                     {},
                     None,
+                    comment.get("links", []),
                 )
                 result.append(comment)
             except KeyError:
@@ -408,8 +429,8 @@ class CommentManyTasksResource(Resource):
         allowed_comments = []
         for comment in comments:
             try:
-                task = tasks_service.get_task_with_relations(
-                    comment["object_id"],
+                task = tasks_service.get_task(
+                    comment["object_id"], relations=True
                 )
                 if (
                     person["role"] == "supervisor"
@@ -469,9 +490,7 @@ class ReplyCommentResource(Resource, ArgsMixin):
             ]
         )
 
-        task = tasks_service.get_task(task_id)
-        user_service.check_project_access(task["project_id"])
-        user_service.check_entity_access(task["entity_id"])
+        user_service.check_task_access(task_id)
         return comments_service.reply_comment(comment_id, args["text"])
 
 
@@ -510,9 +529,7 @@ class DeleteReplyCommentResource(Resource):
             200:
                 description: Given comment reply deleted
         """
-        task = tasks_service.get_task(task_id)
-        user_service.check_project_access(task["project_id"])
-        user_service.check_entity_access(task["entity_id"])
+        user_service.check_task_access(task_id)
         reply = comments_service.get_reply(comment_id, reply_id)
         current_user = persons_service.get_current_user()
         if reply["person_id"] != current_user["id"]:

zou/app/blueprints/crud/__init__.py

@@ -123,6 +123,12 @@ from zou.app.blueprints.crud.preview_background_file import (
     PreviewBackgroundFileResource,
     PreviewBackgroundFilesResource,
 )
+from zou.app.blueprints.crud.chat import ChatResource, ChatsResource
+from zou.app.blueprints.crud.chat_message import (
+    ChatMessageResource,
+    ChatMessagesResource,
+)
+from zou.app.blueprints.crud.studio import StudioResource, StudiosResource
 
 routes = [
     ("/data/persons", PersonsResource),
@@ -195,11 +201,17 @@ routes = [
     ("/data/subscriptions/<instance_id>", SubscriptionResource),
     ("/data/entity-links/", EntityLinksResource),
     ("/data/entity-links/<instance_id>", EntityLinkResource),
+    ("/data/chats/", ChatsResource),
+    ("/data/chats/<instance_id>", ChatResource),
+    ("/data/chat-messages/", ChatMessagesResource),
+    ("/data/chat-messages/<instance_id>", ChatMessageResource),
     ("/data/preview-background-files", PreviewBackgroundFilesResource),
     (
         "/data/preview-background-files/<instance_id>",
         PreviewBackgroundFileResource,
     ),
+    ("/data/studios", StudiosResource),
+    ("/data/studios/<instance_id>", StudioResource),
 ]
 
 blueprint = Blueprint("/data", "data")

zou/app/blueprints/crud/attachment_file.py

@@ -2,7 +2,9 @@ from zou.app.models.attachment_file import AttachmentFile
 
 from zou.app.blueprints.crud.base import BaseModelResource, BaseModelsResource
 
-from zou.app.services import tasks_service, user_service
+from zou.app.services import chats_service, tasks_service, user_service
+
+from zou.app.utils.permissions import PermissionDenied
 
 
 class AttachmentFilesResource(BaseModelsResource):
@@ -16,8 +18,15 @@ class AttachmentFileResource(BaseModelResource):
 
     def check_read_permissions(self, instance):
         attachment_file = instance
-        comment = tasks_service.get_comment(attachment_file["comment_id"])
-        task = tasks_service.get_task(comment["object_id"])
-        user_service.check_project_access(task["project_id"])
-        user_service.check_entity_access(task["entity_id"])
+        if attachment_file["comment_id"] is not None:
+            comment = tasks_service.get_comment(attachment_file["comment_id"])
+            user_service.check_task_access(comment["object_id"])
+        elif attachment_file["chat_message_id"] is not None:
+            message = chats_service.get_chat_message(
+                attachment_file["chat_message_id"]
+            )
+            chat = chats_service.get_chat(message["chat_id"])
+            user_service.check_entity_access(chat["object_id"])
+        else:
+            raise PermissionDenied()
         return True

zou/app/blueprints/crud/base.py

@@ -12,7 +12,6 @@ from sqlalchemy.inspection import inspect
 from zou.app.mixin import ArgsMixin
 from zou.app.utils import events, fields, permissions, query
 from zou.app.services.exception import (
-    ArgumentsException,
     WrongParameterException,
 )
 
@@ -27,7 +26,10 @@ class BaseModelsResource(Resource, ArgsMixin):
         if query is None:
             query = self.model.query
 
-        return self.model.serialize_list(query.all(), relations=relations)
+        return self.serialize_list(query.all(), relations=relations)
+
+    def serialize_list(self, entries, relations=False):
+        return self.model.serialize_list(entries, relations=relations)
 
     def paginated_entries(self, query, page, limit=None, relations=False):
         total = query.count()
@@ -35,7 +37,11 @@ class BaseModelsResource(Resource, ArgsMixin):
         offset = (page - 1) * limit
 
         nb_pages = int(math.ceil(total / float(limit)))
-        query = query.order_by(self.model.updated_at.desc())
+        query = query.order_by(
+            self.model.updated_at.desc(),
+            self.model.created_at.desc(),
+            self.model.id,
+        )
         query = query.limit(limit)
         query = query.offset(offset)
 
@@ -75,7 +81,11 @@ class BaseModelsResource(Resource, ArgsMixin):
                 ) and isinstance(
                     field_key.property, orm.properties.RelationshipProperty
                 )
-                value_is_list = len(value) > 0 and value[0] == "["
+                value_is_list = (
+                    hasattr(value, "__len__")
+                    and len(value) > 0
+                    and value[0] == "["
+                )
 
                 if key == "name" and field_key is not None:
                     name_filter.append(value)
@@ -119,7 +129,7 @@ class BaseModelsResource(Resource, ArgsMixin):
 
         return query
 
-    def check_read_permissions(self):
+    def check_read_permissions(self, options=None):
         return permissions.check_admin_permissions()
 
     def add_project_permission_filter(self, query):
@@ -157,13 +167,14 @@ class BaseModelsResource(Resource, ArgsMixin):
                 description: Permission denied
         """
         try:
-            self.check_read_permissions()
             query = self.model.query
             if not request.args:
+                self.check_read_permissions()
                 query = self.add_project_permission_filter(query)
                 return self.all_entries(query)
             else:
                 options = request.args
+                self.check_read_permissions(options)
                 query = self.apply_filters(query, options)
                 query = self.add_project_permission_filter(query)
                 page = int(options.get("page", "-1"))
@@ -229,7 +240,7 @@ class BaseModelsResource(Resource, ArgsMixin):
         try:
             data = request.json
             if data is None:
-                raise ArgumentsException(
+                raise WrongParameterException(
                     "Data are empty. Please verify that you sent JSON data and"
                     " that you set the right headers."
                 )
@@ -245,18 +256,11 @@ class BaseModelsResource(Resource, ArgsMixin):
             TypeError,
             IntegrityError,
             StatementError,
+            KeyError,
         ) as exception:
             current_app.logger.error(str(exception), exc_info=1)
             return {"message": str(exception)}, 400
 
-        except ArgumentsException as exception:
-            current_app.logger.error(str(exception), exc_info=1)
-            return (
-                exception.dict
-                if exception.dict is not None
-                else {"message": str(exception)}
-            ), 400
-
     def emit_create_event(self, instance_dict):
         return events.emit(
             "%s:new" % self.model.__tablename__.replace("_", "-"),
@@ -280,10 +284,14 @@ class BaseModelResource(Resource, ArgsMixin):
             abort(404)
         return instance
 
-    def check_read_permissions(self, instance):
+    def get_serialized_instance(self, instance_id, relations=True):
+        instance = self.get_model_or_404(instance_id)
+        return self.serialize_instance(instance, relations=relations)
+
+    def check_read_permissions(self, instance_dict):
         return permissions.check_admin_permissions()
 
-    def check_update_permissions(self, instance, data):
+    def check_update_permissions(self, instance_dict, data):
         return permissions.check_admin_permissions()
 
     def check_delete_permissions(self, instance_dict):
@@ -328,8 +336,9 @@ class BaseModelResource(Resource, ArgsMixin):
         """
         relations = self.get_bool_parameter("relations", "true")
         try:
-            instance = self.get_model_or_404(instance_id)
-            result = self.serialize_instance(instance, relations=relations)
+            result = self.get_serialized_instance(
+                instance_id, relations=relations
+            )
             self.check_read_permissions(result)
             result = self.clean_get_result(result)
 
@@ -397,7 +406,7 @@ class BaseModelResource(Resource, ArgsMixin):
         try:
             data = self.get_arguments()
             if data is None:
-                raise ArgumentsException(
+                raise WrongParameterException(
                     "Data are empty. Please verify that you sent JSON data and"
                     " that you set the right headers."
                 )
@@ -420,14 +429,6 @@ class BaseModelResource(Resource, ArgsMixin):
             current_app.logger.error(str(exception), exc_info=1)
             return {"message": str(exception)}, 400
 
-        except ArgumentsException as exception:
-            current_app.logger.error(str(exception), exc_info=1)
-            return (
-                exception.dict
-                if exception.dict is not None
-                else {"message": str(exception)}
-            ), 400
-
     @jwt_required()
     def delete(self, instance_id):
         """

zou/app/blueprints/crud/chat.py

@@ -0,0 +1,13 @@
+from zou.app.models.chat import Chat
+
+from zou.app.blueprints.crud.base import BaseModelResource, BaseModelsResource
+
+
+class ChatsResource(BaseModelsResource):
+    def __init__(self):
+        BaseModelsResource.__init__(self, Chat)
+
+
+class ChatResource(BaseModelResource):
+    def __init__(self):
+        BaseModelResource.__init__(self, Chat)

zou/app/blueprints/crud/chat_message.py

@@ -0,0 +1,13 @@
+from zou.app.models.chat_message import ChatMessage
+
+from zou.app.blueprints.crud.base import BaseModelResource, BaseModelsResource
+
+
+class ChatMessagesResource(BaseModelsResource):
+    def __init__(self):
+        BaseModelsResource.__init__(self, ChatMessage)
+
+
+class ChatMessageResource(BaseModelResource):
+    def __init__(self):
+        BaseModelResource.__init__(self, ChatMessage)