zou 0.20.37__py3-none-any.whl → 0.20.39__py3-none-any.whl

zou/app/blueprints/projects/resources.py

@@ -2,6 +2,7 @@ from flask_restful import Resource
 from flask_jwt_extended import jwt_required
 
 
+from zou.app.services import budget_service
 from zou.app.mixin import ArgsMixin
 from zou.app.services import (
     projects_service,
@@ -165,7 +166,7 @@ class ProductionTeamRemoveResource(Resource):
             x-example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             204:
-              description: Person removed from production team
+              description: Empty response
         """
         user_service.check_manager_project_access(project_id)
         projects_service.remove_team_member(project_id, person_id)
@@ -237,7 +238,7 @@ class ProductionAssetTypeRemoveResource(Resource):
             x-example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             204:
-              description: Asset type removed from production
+              description: Empty response
         """
         user_service.check_manager_project_access(project_id)
         projects_service.remove_asset_type_setting(project_id, asset_type_id)
@@ -343,7 +344,7 @@ class ProductionTaskTypeRemoveResource(Resource):
             x-example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             204:
-              description: Task type removed from production
+              description: Empty response
         """
         user_service.check_manager_project_access(project_id)
         projects_service.remove_task_type_setting(project_id, task_type_id)
@@ -436,7 +437,7 @@ class ProductionTaskStatusRemoveResource(Resource):
             x-example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             204:
-              description: Task status removed from production
+              description: Empty response
         """
         user_service.check_manager_project_access(project_id)
         projects_service.remove_task_status_setting(project_id, task_status_id)
@@ -529,7 +530,7 @@ class ProductionStatusAutomationRemoveResource(Resource):
             x-example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             204:
-              description: Status automation removed from production
+              description: Empty response
         """
         user_service.check_manager_project_access(project_id)
         projects_service.remove_status_automation_setting(
@@ -626,7 +627,7 @@ class ProductionPreviewBackgroundFileRemoveResource(Resource):
             x-example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             204:
-              description: Preview background file removed from production
+              description: Empty response
         """
         user_service.check_manager_project_access(project_id)
         projects_service.remove_preview_background_file_setting(
@@ -864,7 +865,7 @@ class ProductionMetadataDescriptorResource(Resource, ArgsMixin):
             x-example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             204:
-              description: Metadata descriptor deleted
+              description: Empty response
         """
         user_service.check_all_departments_access(
             project_id,
@@ -1092,3 +1093,397 @@ class ProductionSequencesScheduleItemsResource(Resource):
         return schedule_service.get_sequences_schedule_items(
             project_id, task_type_id
         )
+
+
+class ProductionBudgetsResource(Resource, ArgsMixin):
+
+    @jwt_required()
+    def get(self, project_id):
+        """
+        Retrieve budgets for given production
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            200:
+              description: All budgets of given production
+        """
+        user_service.check_manager_project_access(project_id)
+        self.check_id_parameter(project_id)
+        return budget_service.get_budgets(project_id)
+
+    @jwt_required()
+    def post(self, project_id):
+        """
+        Create a budget for given production.
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: name
+            required: true
+            type: string
+            x-example: "New Budget"
+          - in: formData
+            name: currency
+            required: false
+            type: string
+            x-example: "USD"
+        responses:
+            201:
+              description: Budget created
+        """
+        self.check_id_parameter(project_id)
+        user_service.check_manager_project_access(project_id)
+        data = self.get_args([("name", None, True), ("currency", None, False)])
+        if data["currency"] is None:
+            data["currency"] = "USD"
+        return budget_service.create_budget(
+            project_id, data["name"], data["currency"]
+        )
+
+
+class ProductionBudgetResource(Resource, ArgsMixin):
+    """
+    Resource to retrieve a budget for given production.
+    """
+
+    @jwt_required()
+    def get(self, project_id, budget_id):
+        """
+        Retrieve a budget for given production
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: budget_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            200:
+              description: Budget retrieved
+        """
+        self.check_id_parameter(project_id)
+        self.check_id_parameter(budget_id)
+        user_service.check_manager_project_access(project_id)
+        return budget_service.get_budget(budget_id)
+
+    @jwt_required()
+    def put(self, project_id, budget_id):
+        """
+        Update a budget name for given production
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: budget_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: name
+            required: false
+            type: string
+            x-example: "New Budget"
+          - in: formData
+            name: currency
+            required: false
+            type: string
+            x-example: "USD"
+        responses:
+            200:
+              description: Budget updated
+        """
+        self.check_id_parameter(project_id)
+        self.check_id_parameter(budget_id)
+        user_service.check_manager_project_access(project_id)
+        data = self.get_args(
+            [("name", None, False), ("currency", None, False)]
+        )
+        return budget_service.update_budget(
+            budget_id, name=data["name"], currency=data["currency"]
+        )
+
+    @jwt_required()
+    def delete(self, project_id, budget_id):
+        """
+        Delete a budget for given production
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: budget_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            204:
+              description: Empty response
+        """
+        self.check_id_parameter(project_id)
+        self.check_id_parameter(budget_id)
+        user_service.check_manager_project_access(project_id)
+        budget_service.delete_budget(budget_id)
+        return "", 204
+
+
+class ProductionBudgetEntriesResource(Resource, ArgsMixin):
+
+    @jwt_required()
+    def get(self, project_id, budget_id):
+        """
+        Retrieve budget entries for given production
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: budget_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            200:
+              description: All budget entries of given production and budget
+        """
+        self.check_id_parameter(project_id)
+        self.check_id_parameter(budget_id)
+        user_service.check_manager_project_access(project_id)
+        return budget_service.get_budget_entries(budget_id)
+
+    @jwt_required()
+    def post(self, project_id, budget_id):
+        """
+        Create a budget entry for given production and budget
+        """
+        self.check_id_parameter(project_id)
+        self.check_id_parameter(budget_id)
+        user_service.check_manager_project_access(project_id)
+        data = self.get_args(
+            [
+                ("department_id", None, True),
+                ("person_id", None, False),
+                ("start_date", None, False),
+                ("months_duration", None, False),
+                ("daily_salary", None, False),
+                ("position", None, False),
+                ("seniority", None, False),
+            ]
+        )
+        return budget_service.create_budget_entry(
+            budget_id,
+            data["department_id"],
+            data["start_date"],
+            data["months_duration"],
+            data["daily_salary"],
+            data["position"],
+            data["seniority"],
+            person_id=data["person_id"],
+        )
+
+
+class ProductionBudgetEntryResource(Resource, ArgsMixin):
+
+    @jwt_required()
+    def get(self, project_id, budget_id, entry_id):
+        """
+        Retrieve a budget entry for given production and budget
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: budget_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: entry_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            200:
+              description: Budget entry retrieved
+        """
+        user_service.check_manager_project_access(project_id)
+        self.check_id_parameter(project_id)
+        self.check_id_parameter(budget_id)
+        self.check_id_parameter(entry_id)
+        return budget_service.get_budget_entry(entry_id)
+
+    @jwt_required()
+    def put(self, project_id, budget_id, entry_id):
+        """
+        Update a budget entry for given production and budget
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: budget_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: entry_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: department_id
+            required: false
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: person_id
+            required: false
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: start_date
+            required: false
+            type: string
+            format: date
+            x-example: 2025-01-01
+          - in: formData
+            name: months_duration
+            required: false
+            type: integer
+            x-example: 12
+          - in: formData
+            name: daily_salary
+            required: false
+            type: float
+            x-example: 100.00
+          - in: formData
+            name: position
+            required: false
+            type: string
+            x-example: "Artist"
+          - in: formData
+            name: seniority
+            required: false
+            type: string
+            x-example: "Mid"
+        responses:
+            200:
+              description: Budget entry updated
+        """
+        user_service.check_manager_project_access(project_id)
+        self.check_id_parameter(project_id)
+        self.check_id_parameter(budget_id)
+        self.check_id_parameter(entry_id)
+        data = self.get_args(
+            [
+                ("department_id", None, False),
+                ("person_id", None, False),
+                ("start_date", None, False),
+                ("months_duration", None, False),
+                ("daily_salary", None, False),
+                ("position", None, False),
+                ("seniority", None, False),
+            ]
+        )
+        return budget_service.update_budget_entry(entry_id, data)
+
+    @jwt_required()
+    def delete(self, project_id, budget_id, entry_id):
+        """
+        Delete a budget entry for given production and budget.
+        ---
+        tags:
+          - Projects
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: budget_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: path
+            name: entry_id
+            required: true
+            type: string
+            format: UUID
+            x-example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            204:
+              description: empty response
+        """
+        self.check_id_parameter(project_id)
+        self.check_id_parameter(budget_id)
+        self.check_id_parameter(entry_id)
+        user_service.check_manager_project_access(project_id)
+        budget_service.delete_budget_entry(entry_id)
+        return "", 204

zou/app/blueprints/shots/resources.py

@@ -565,6 +565,7 @@ class SequenceTaskTypesResource(Resource):
 
 
 class ShotsAndTasksResource(Resource):
+
     @jwt_required()
     def get(self):
         """

zou/app/mixin.py

@@ -1,7 +1,7 @@
 from flask_restful import reqparse
 from flask import request
 
-from zou.app.utils import date_helpers
+from zou.app.utils import date_helpers, fields
 from zou.app.services.exception import WrongParameterException
 
 
@@ -11,6 +11,9 @@ class ArgsMixin(object):
     """
 
     def get_args(self, descriptors, location=None):
+        """
+        Retrieve arguments from GET or POST queries.
+        """
         parser = reqparse.RequestParser()
         if location is None:
             location = ["values", "json"] if request.is_json else ["values"]
@@ -157,3 +160,11 @@ class ArgsMixin(object):
                     "Expected format: 2020-01-05T13:23:10 or 2020-01-05"
                 )
         return date
+
+    def check_id_parameter(self, uuid):
+        """
+        Check if the given UUID is valid.
+        """
+        if not fields.is_valid_id(uuid):
+            raise WrongParameterException("Wrong UUID format.")
+        return True

zou/app/models/budget.py

@@ -0,0 +1,39 @@
+from sqlalchemy_utils import UUIDType
+
+from zou.app import db
+from zou.app.models.serializer import SerializerMixin
+from zou.app.models.base import BaseMixin
+from zou.app.utils import fields
+
+
+class Budget(db.Model, BaseMixin, SerializerMixin):
+    """
+    Budget quote for a project. It's a base object where budget entries
+    are linked to.
+    """
+
+    project_id = db.Column(
+        UUIDType(binary=False), db.ForeignKey("project.id"), index=True
+    )
+    revision = db.Column(db.Integer, nullable=False, default=1)
+    name = db.Column(db.String(255), nullable=False)
+    currency = db.Column(db.String(3))
+
+    def __repr__(self):
+        return "<Budget of %s - %d %s %s>" % (
+            self.project_id,
+            self.revision,
+            self.name,
+            self.id,
+        )
+
+    def present(self):
+        return fields.serialize_dict(
+            {
+                "id": self.id,
+                "project_id": self.project_id,
+                "revision": self.revision,
+                "name": self.name,
+                "currency": self.currency,
+            }
+        )

zou/app/models/budget_entry.py

@@ -0,0 +1,65 @@
+from sqlalchemy_utils import (
+    UUIDType,
+    ChoiceType,
+)
+
+from zou.app import db
+from zou.app.models.serializer import SerializerMixin
+from zou.app.models.base import BaseMixin
+from zou.app.utils import fields
+
+from zou.app.models.person import POSITION_TYPES, SENIORITY_TYPES
+
+
+class BudgetEntry(db.Model, BaseMixin, SerializerMixin):
+    """
+    Budget entry for a budget. It stores the information about a person
+    (present or not) salary for a given department.
+    """
+
+    budget_id = db.Column(
+        UUIDType(binary=False),
+        db.ForeignKey("budget.id"),
+        index=True,
+        nullable=False,
+    )
+    department_id = db.Column(
+        UUIDType(binary=False),
+        db.ForeignKey("department.id"),
+        index=True,
+        nullable=False,
+    )
+    person_id = db.Column(
+        UUIDType(binary=False),
+        db.ForeignKey("person.id"),
+        index=True,
+        nullable=True,
+    )
+    start_date = db.Column(db.Date, nullable=False)
+    months_duration = db.Column(db.Integer, nullable=False)
+    daily_salary = db.Column(db.Float, nullable=False)
+    position = db.Column(ChoiceType(POSITION_TYPES), default="artist")
+    seniority = db.Column(ChoiceType(SENIORITY_TYPES), default="mid")
+
+    def __repr__(self):
+        return "<BudgetEntry of %s - %d %s %s>" % (
+            self.budget_id,
+            self.department_id,
+            self.person_id,
+            self.start_date,
+        )
+
+    def present(self):
+        return fields.serialize_dict(
+            {
+                "id": self.id,
+                "budget_id": self.budget_id,
+                "department_id": self.department_id,
+                "person_id": self.person_id,
+                "start_date": self.start_date,
+                "months_duration": self.months_duration,
+                "daily_salary": self.daily_salary,
+                "position": self.position,
+                "seniority": self.seniority,
+            }
+        )

zou/app/models/person.py

@@ -13,8 +13,8 @@ from pytz import timezone as pytz_timezone
 from babel import Locale
 
 from zou.app.models.serializer import SerializerMixin
-from zou.app.models.base import BaseMixin
 from zou.app.models.department import Department
+from zou.app.models.base import BaseMixin
 from zou.app import config, db
 
 
@@ -42,6 +42,18 @@ ROLE_TYPES = [
     ("vendor", "Vendor"),
 ]
 
+POSITION_TYPES = [
+    ("supervisor", "Supervisor"),
+    ("lead", "Lead"),
+    ("artist", "Artist"),
+]
+
+SENIORITY_TYPES = [
+    ("senior", "Senior"),
+    ("mid", "Mid"),
+    ("junior", "Junior"),
+]
+
 
 class DepartmentLink(db.Model):
     __tablename__ = "department_link"
@@ -107,6 +119,10 @@ class Person(db.Model, BaseMixin, SerializerMixin):
     locale = db.Column(LocaleType, default=Locale(config.DEFAULT_LOCALE))
     data = db.Column(JSONB)
     role = db.Column(ChoiceType(ROLE_TYPES), default="user", nullable=False)
+    position = db.Column(ChoiceType(POSITION_TYPES), default="artist")
+    seniority = db.Column(ChoiceType(SENIORITY_TYPES), default="mid")
+    daily_salary = db.Column(db.Integer, default=0)
+
     has_avatar = db.Column(db.Boolean(), default=False)
 
     notifications_enabled = db.Column(db.Boolean(), default=False)

zou/app/models/plugin.py

@@ -0,0 +1,21 @@
+from zou.app import db
+from zou.app.models.serializer import SerializerMixin
+from zou.app.models.base import BaseMixin
+from sqlalchemy_utils import EmailType, URLType
+
+
+class Plugin(db.Model, BaseMixin, SerializerMixin):
+    """
+    Describe a plugin.
+    """
+
+    plugin_id = db.Column(
+        db.String(80), unique=True, nullable=False, index=True
+    )
+    name = db.Column(db.String(80), nullable=False, index=True)
+    description = db.Column(db.Text())
+    version = db.Column(db.String(50), nullable=False)
+    maintainer_name = db.Column(db.String(200), nullable=False)
+    maintainer_email = db.Column(EmailType)
+    website = db.Column(URLType)
+    license = db.Column(db.String(80), nullable=False)

zou/app/models/salary_scale.py

@@ -0,0 +1,28 @@
+from sqlalchemy_utils import UUIDType
+from sqlalchemy_utils import ChoiceType
+
+from zou.app.models.person import POSITION_TYPES, SENIORITY_TYPES
+
+from zou.app import db
+from zou.app.models.serializer import SerializerMixin
+from zou.app.models.base import BaseMixin
+
+
+class SalaryScale(db.Model, BaseMixin, SerializerMixin):
+    """
+    Model to represent a salary scale tied to a department.
+    """
+
+    department_id = db.Column(
+        UUIDType(binary=False),
+        db.ForeignKey("department.id"),
+        index=True,
+        nullable=False,
+    )
+
+    position = db.Column(ChoiceType(POSITION_TYPES), default="artist")
+    seniority = db.Column(ChoiceType(SENIORITY_TYPES), default="mid")
+    salary = db.Column(db.Integer, nullable=False, default=0)
+
+    def present(self):
+        return self.serialize()