zou 0.20.72__py3-none-any.whl → 0.20.74__py3-none-any.whl

zou/app/blueprints/projects/resources.py

@@ -1,3 +1,4 @@
+from flask import abort
 from flask_restful import Resource
 from flask_jwt_extended import jwt_required
 
@@ -13,7 +14,10 @@ from zou.app.services import (
     user_service,
 )
 from zou.app.utils import permissions
-from zou.app.services.exception import WrongParameterException
+from zou.app.services.exception import (
+    WrongParameterException,
+    WrongDateFormatException,
+)
 from zou.app.models.metadata_descriptor import METADATA_DESCRIPTOR_TYPES
 
 
@@ -32,8 +36,23 @@ class OpenProjectsResource(Resource, ArgsMixin):
           - Projects
         description: Most of the time, past projects are not needed.
         responses:
-            200:
-              description: All running projects
+          '200':
+            description: All running projects
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                      name:
+                        type: string
+                      project_status_id:
+                        type: string
+                        format: uuid
         """
         name = self.get_text_parameter("name")
         if permissions.has_admin_permissions():
@@ -57,8 +76,23 @@ class AllProjectsResource(Resource, ArgsMixin):
           - Projects
         description: Ensure that user has at least the manager level before that.
         responses:
-            200:
-              description: All projects listed in database
+          '200':
+            description: All projects listed in database
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                      name:
+                        type: string
+                      project_status_id:
+                        type: string
+                        format: uuid
         """
         name = self.get_text_parameter("name")
         try:
@@ -91,12 +125,31 @@ class ProductionTeamResource(Resource, ArgsMixin):
           - in: path
             name: project_id
             required: true
-            type: string
-            format: uuid
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            200:
-              description: People listed in a production team
+          '200':
+            description: People listed in a production team
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                      first_name:
+                        type: string
+                      last_name:
+                        type: string
+                      email:
+                        type: string
+          '404':
+            description: Project not found
         """
         user_service.check_project_access(project_id)
         project = projects_service.get_project_raw(project_id)
@@ -119,18 +172,40 @@ class ProductionTeamResource(Resource, ArgsMixin):
           - in: path
             name: project_id
             required: true
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
-          - in: formData
-            name: person_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/x-www-form-urlencoded:
+              schema:
+                type: object
+                required:
+                  - person_id
+                properties:
+                  person_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            201:
-              description: Person added to the production team
+          '201':
+            description: Person added to the production team
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      format: uuid
+                    name:
+                      type: string
+          '400':
+            description: Invalid parameters
+          '404':
+            description: Project or person not found
         """
         args = self.get_args([("person_id", "", True)])
 
@@ -168,7 +243,9 @@ class ProductionTeamRemoveResource(Resource):
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             204:
-              description: Empty response
+              description: Person removed from production team
+            404:
+              description: Project or person not found
         """
         user_service.check_manager_project_access(project_id)
         projects_service.remove_team_member(project_id, person_id)
@@ -191,18 +268,40 @@ class ProductionAssetTypeResource(Resource, ArgsMixin):
           - in: path
             name: project_id
             required: true
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
-          - in: formData
-            name: asset_type_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/x-www-form-urlencoded:
+              schema:
+                type: object
+                required:
+                  - asset_type_id
+                properties:
+                  asset_type_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            201:
-              description: Asset type added to production
+          '201':
+            description: Asset type added to production
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      format: uuid
+                    name:
+                      type: string
+          '400':
+            description: Invalid parameters
+          '404':
+            description: Project or asset type not found
         """
         args = self.get_args([("asset_type_id", "", True)])
 
@@ -290,23 +389,43 @@ class ProductionTaskTypeResource(Resource, ArgsMixin):
           - in: path
             name: project_id
             required: true
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
-          - in: formData
-            name: task_type_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
-          - in: formData
-            name: priority
-            required: False
-            type: string
-            default: "None"
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/x-www-form-urlencoded:
+              schema:
+                type: object
+                required:
+                  - task_type_id
+                properties:
+                  task_type_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  priority:
+                    type: string
+                    default: "None"
         responses:
-            201:
-              description: Asset type added to production
+          '201':
+            description: Task type added to production
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      format: uuid
+                    name:
+                      type: string
+          '400':
+            description: Invalid parameters
+          '404':
+            description: Project or task type not found
         """
         args = self.get_args(
             [("task_type_id", "", True), ("priority", None, False)]
@@ -382,7 +501,7 @@ class ProductionTaskStatusResource(Resource, ArgsMixin):
     @jwt_required()
     def post(self, project_id):
         """
-        Add a task type linked to a production.
+        Add a task status linked to a production.
         ---
         tags:
           - Projects
@@ -390,18 +509,40 @@ class ProductionTaskStatusResource(Resource, ArgsMixin):
           - in: path
             name: project_id
             required: true
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
-          - in: formData
-            name: task_status_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/x-www-form-urlencoded:
+              schema:
+                type: object
+                required:
+                  - task_status_id
+                properties:
+                  task_status_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            201:
-              description: Task type added to production
+          '201':
+            description: Task status added to production
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      format: uuid
+                    name:
+                      type: string
+          '400':
+            description: Invalid parameters
+          '404':
+            description: Project or task status not found
         """
         args = self.get_args([("task_status_id", "", True)])
 
@@ -681,12 +822,63 @@ class ProductionMetadataDescriptorsResource(Resource, ArgsMixin):
           - in: path
             name: project_id
             required: true
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/x-www-form-urlencoded:
+              schema:
+                type: object
+                required:
+                  - name
+                  - data_type
+                properties:
+                  entity_type:
+                    type: string
+                    default: "Asset"
+                    enum: ["Asset", "Shot", "Edit", "Episode", "Sequence"]
+                  name:
+                    type: string
+                    description: Name of the metadata descriptor
+                  data_type:
+                    type: string
+                    description: Type of data (string, number, boolean, etc.)
+                  for_client:
+                    type: string
+                    default: "False"
+                    example: "True"
+                  choices:
+                    type: array
+                    items:
+                      type: string
+                    example: ["option1", "option2"]
+                  departments:
+                    type: array
+                    items:
+                      type: string
+                    example: ["department1", "department2"]
         responses:
-            201:
-              description: Create a new metadata descriptor
+          '201':
+            description: Metadata descriptor created
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      format: uuid
+                    name:
+                      type: string
+                    data_type:
+                      type: string
+          '400':
+            description: Invalid parameters
+          '404':
+            description: Project not found
         """
         args = self.get_args(
             [
@@ -799,19 +991,24 @@ class ProductionMetadataDescriptorResource(Resource, ArgsMixin):
             required: False
           - in: formData
             name: for_client
-            required: True
-            type: boolean
-            default: False
-            required: False
+            required: false
+            type: string
+            default: "False"
+            example: "True"
           - in: formData
             name: choices
-            required: True
+            required: false
             type: array
-            required: False
+            items:
+              type: string
+            example: ["option1", "option2"]
           - in: formData
             name: departments
+            required: false
             type: array
-            required: False
+            items:
+              type: string
+            example: ["department1", "department2"]
         responses:
             200:
               description: Metadata descriptor updated
@@ -1132,22 +1329,45 @@ class ProductionBudgetsResource(Resource, ArgsMixin):
           - in: path
             name: project_id
             required: true
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
-          - in: formData
-            name: name
-            required: true
-            type: string
-            example: "New Budget"
-          - in: formData
-            name: currency
-            required: false
-            type: string
-            example: "USD"
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/x-www-form-urlencoded:
+              schema:
+                type: object
+                required:
+                  - name
+                properties:
+                  name:
+                    type: string
+                    example: "New Budget"
+                  currency:
+                    type: string
+                    default: "USD"
+                    example: "USD"
         responses:
-            201:
-              description: Budget created
+          '201':
+            description: Budget created
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      format: uuid
+                    name:
+                      type: string
+                    currency:
+                      type: string
+          '400':
+            description: Invalid parameters
+          '404':
+            description: Project not found
         """
         self.check_id_parameter(project_id)
         user_service.check_manager_project_access(project_id)
@@ -1303,6 +1523,76 @@ class ProductionBudgetEntriesResource(Resource, ArgsMixin):
     def post(self, project_id, budget_id):
         """
         Create a budget entry for given production and budget
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: budget_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/x-www-form-urlencoded:
+              schema:
+                type: object
+                required:
+                  - department_id
+                properties:
+                  department_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  person_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  start_date:
+                    type: string
+                    format: date
+                    example: "2025-01-01"
+                  months_duration:
+                    type: integer
+                    example: 12
+                  daily_salary:
+                    type: number
+                    format: float
+                    example: 100.00
+                  position:
+                    type: string
+                    example: "Artist"
+                  seniority:
+                    type: string
+                    example: "Mid"
+        responses:
+          '201':
+            description: Budget entry created
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      format: uuid
+                    department_id:
+                      type: string
+                      format: uuid
+          '400':
+            description: Invalid parameters
+          '404':
+            description: Project or budget not found
         """
         self.check_id_parameter(project_id)
         self.check_id_parameter(budget_id)
@@ -1506,19 +1796,19 @@ class ProductionMonthTimeSpentsResource(Resource, ArgsMixin):
         Get aggregated time spents by month for given project.
         ---
         tags:
-        - Projects
+          - Projects
         parameters:
-        - in: path
-          name: project_id
-          required: True
-          type: string
-          format: uuid
-          example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
           200:
-              description: Aggregated time spents for given person and month
+            description: Aggregated time spents for given person and month
           400:
-              description: Wrong ID format
+            description: Wrong ID format
         """
         permissions.check_admin_permissions()
         self.check_id_parameter(project_id)
@@ -1536,25 +1826,25 @@ class ProductionScheduleVersionTaskLinksResource(Resource, ArgsMixin):
         Get task links for given production schedule version.
         ---
         tags:
-        - Projects
+          - Projects
         parameters:
-        - in: path
-          name: production_schedule_version_id
-          required: True
-          type: string
-          format: uuid
-          example: a24a6ea4-ce75-4665-a070-57453082c25
-        - in: query
-          name: task_type_id
-          required: false
-          type: string
-          format: uuid
-          example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: production_schedule_version_id
+            required: true
+            type: string
+            format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: task_type_id
+            required: false
+            type: string
+            format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            200:
-                description: Task links for given production schedule version.
-            400:
-                description: Wrong ID format
+          200:
+            description: Task links for given production schedule version
+          400:
+            description: Wrong ID format
         """
         production_schedule_version = (
             schedule_service.get_production_schedule_version(
@@ -1595,19 +1885,19 @@ class ProductionScheduleVersionSetTaskLinksFromTasksResource(
         Set task links for given production schedule version from tasks.
         ---
         tags:
-        - Projects
+          - Projects
         parameters:
-        - in: path
-          name: production_schedule_version_id
-          required: True
-          type: string
-          format: uuid
-          example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: production_schedule_version_id
+            required: true
+            type: string
+            format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            200:
-                description: Task links created.
-            400:
-                description: Wrong ID format
+          200:
+            description: Task links created
+          400:
+            description: Wrong ID format
         """
         production_schedule_version = (
             schedule_service.get_production_schedule_version(
@@ -1631,19 +1921,19 @@ class ProductionScheduleVersionApplyToProductionResource(Resource, ArgsMixin):
         Apply production schedule version to production.
         ---
         tags:
-        - Projects
+          - Projects
         parameters:
-        - in: path
-          name: production_schedule_version_id
-          required: True
-          type: string
-          format: uuid
-          example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: production_schedule_version_id
+            required: true
+            type: string
+            format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            200:
-                description: Task links created.
-            400:
-                description: Wrong ID format
+          200:
+            description: Production schedule version applied
+          400:
+            description: Wrong ID format
         """
         production_schedule_version = (
             schedule_service.get_production_schedule_version(
@@ -1671,25 +1961,25 @@ class ProductionScheduleVersionSetTaskLinksFromProductionScheduleVersionResource
         Set task links for given production schedule version from another production schedule version.
         ---
         tags:
-        - Projects
+          - Projects
         parameters:
-        - in: path
-          name: production_schedule_version_id
-          required: True
-          type: string
-          format: uuid
-          example: a24a6ea4-ce75-4665-a070-57453082c25
-        - in: formData
-          name: production_schedule_version_id
-          required: True
-          type: string
-          format: uuid
-          example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: production_schedule_version_id
+            required: true
+            type: string
+            format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: production_schedule_version_id
+            required: true
+            type: string
+            format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            200:
-                description: Task links created.
-            400:
-                description: Wrong ID format
+          200:
+            description: Task links created
+          400:
+            description: Wrong ID format
         """
         production_schedule_version = (
             schedule_service.get_production_schedule_version(
@@ -1726,3 +2016,158 @@ class ProductionScheduleVersionSetTaskLinksFromProductionScheduleVersionResource
                 "id"
             ],
         )
+
+
+class ProductionTaskTypesTimeSpentsResource(Resource, ArgsMixin):
+    """
+    Retrieve time spents for a task type in the production
+    """
+
+    @jwt_required()
+    def get(self, project_id, task_type_id):
+        """
+        Retrieve time spents for a task type in the production
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: task_type_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: start_date
+            required: false
+            schema:
+              type: string
+              format: date
+            example: "2022-07-01"
+          - in: query
+            name: end_date
+            required: false
+            schema:
+              type: string
+              format: date
+            example: "2022-07-31"
+        responses:
+          '200':
+            description: All time spents for given task type and project
+            content:
+              application/json:
+                schema:
+                  type: dict
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                      person_id:
+                        type: string
+                        format: uuid
+                      duration:
+                        type: number
+                        format: float
+                      date:
+                        type: string
+                        format: date
+          '400':
+            description: Invalid date range parameters
+        """
+        user_service.check_manager_project_access(project_id)
+        arguments = self.get_args(["start_date", "end_date"])
+        start_date, end_date = arguments["start_date"], arguments["end_date"]
+        try:
+            return time_spents_service.get_project_task_type_time_spents(
+                project_id, task_type_id, start_date, end_date
+            )
+        except WrongDateFormatException:
+            abort(
+                400,
+                f"Wrong date format for {start_date} and/or {end_date}",
+            )
+
+
+class ProductionDayOffsResource(Resource, ArgsMixin):
+    """
+    Retrieve all day offs for a production
+    """
+
+    @jwt_required()
+    def get(self, project_id):
+        """
+        Retrieve all day offs for a production
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: start_date
+            required: false
+            schema:
+              type: string
+              format: date
+            example: "2022-07-01"
+          - in: query
+            name: end_date
+            required: false
+            schema:
+              type: string
+              format: date
+            example: "2022-07-31"
+        responses:
+          '200':
+            description: All day offs for given project
+            content:
+              application/json:
+                schema:
+                  type: dict
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                      person_id:
+                        type: string
+                        format: uuid
+                      description:
+                        type: string
+                      date:
+                        type: string
+                        format: date
+                      end_date:
+                        type: string
+                        format: date
+          '400':
+            description: Invalid date range parameters
+        """
+        user_service.check_manager_project_access(project_id)
+        arguments = self.get_args(["start_date", "end_date"])
+        start_date, end_date = arguments["start_date"], arguments["end_date"]
+        try:
+            return time_spents_service.get_day_offs_between_for_project(
+                project_id, start_date, end_date
+            )
+        except WrongDateFormatException:
+            abort(
+                400,
+                f"Wrong date format for {start_date} and/or {end_date}",
+            )