wbcore 2.2.1__py2.py3-none-any.whl

wbcore/contrib/directory/serializers/entries.py

@@ -0,0 +1,344 @@
+import phonenumbers
+from django.core.validators import validate_email
+from django.forms import ValidationError
+from django.utils.translation import gettext
+from django.utils.translation import gettext_lazy as _
+from dynamic_preferences.registries import global_preferences_registry
+from rest_framework.reverse import reverse
+from slugify import slugify
+from wbcore import serializers as wb_serializers
+
+from ..models import (
+    ClientManagerRelationship,
+    Company,
+    CompanyType,
+    CustomerStatus,
+    EmailContact,
+    Entry,
+    Person,
+    Specialization,
+    TelephoneContact,
+)
+from .contacts import SocialMediaContactRepresentationSerializer
+from .entry_representations import EntryRepresentationSerializer
+
+
+class CompanyRepresentationSerializer(EntryRepresentationSerializer):
+    _detail_preview = wb_serializers.HyperlinkField(reverse_name="wbcore:directory:company-detail")
+    profile_image = wb_serializers.ImageField(required=False, read_only=True)
+
+    class Meta:
+        model = Company
+        fields = (
+            "id",
+            "computed_str",
+            "_detail",
+            "_detail_preview",
+            "primary_email",
+            "primary_telephone",
+            "profile_image",
+            "_additional_resources",
+        )
+
+
+class BankRepresentationSerializer(CompanyRepresentationSerializer):
+    endpoint = "wbcore:directory:bankrepresentation-list"
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbcore:directory:bank-detail")
+
+
+class PersonRepresentationSerializer(EntryRepresentationSerializer):
+    _detail_preview = wb_serializers.HyperlinkField(reverse_name="wbcore:directory:person-detail")
+    profile_image = wb_serializers.ImageField(required=False, read_only=True)
+
+    class Meta:
+        model = Person
+        fields = (
+            "id",
+            "computed_str",
+            "first_name",
+            "last_name",
+            "_detail",
+            "_detail_preview",
+            "primary_email",
+            "primary_telephone",
+            "profile_image",
+            "_additional_resources",
+        )
+
+
+class InternalUserProfileRepresentationSerializer(PersonRepresentationSerializer):
+    def get_filter_params(self, request):
+        return {"only_internal_users": True}
+
+
+class CompanyTypeModelSerializer(wb_serializers.ModelSerializer):
+    class Meta:
+        model = CompanyType
+        fields = (
+            "id",
+            "title",
+        )
+
+    def validate(self, data):
+        title = data.get("title", None)
+        if title:
+            type = CompanyType.objects.filter(slugify_title=slugify(title, separator=" "))
+            if obj := self.instance:
+                type = type.exclude(id=obj.id)
+            if type.exists():
+                raise ValidationError({"title": _("Cannot add a duplicate company type.")})
+        return data
+
+
+class SpecializationModelSerializer(wb_serializers.ModelSerializer):
+    def validate(self, data):
+        title = data.get("title", None)
+        if title:
+            specialization = Specialization.objects.filter(slugify_title=slugify(title, separator=" "))
+            if obj := self.instance:
+                specialization = specialization.exclude(id=obj.id)
+            if specialization.exists():
+                raise ValidationError({"title": _("Cannot add a duplicate specialization.")})
+        return data
+
+    class Meta:
+        model = Specialization
+        fields = (
+            "id",
+            "title",
+        )
+
+
+class CustomerStatusModelSerializer(wb_serializers.ModelSerializer):
+    class Meta:
+        model = CustomerStatus
+        fields = (
+            "id",
+            "title",
+        )
+
+    def validate(self, data):
+        title = data.get("title", None)
+        if title:
+            status = CustomerStatus.objects.filter(slugify_title=slugify(title, separator=" "))
+            if obj := self.instance:
+                status = status.exclude(id=obj.id)
+            if status.exists():
+                raise ValidationError({"title": _("Cannot add a duplicate customer status.")})
+        return data
+
+
+class CompanyTypeRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    endpoint = "wbcore:directory:companytyperepresentation-list"
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbcore:directory:companytype-detail")
+
+    class Meta:
+        model = CompanyType
+        fields = (
+            "id",
+            "title",
+            "_detail",
+        )
+
+
+class CustomerStatusRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    endpoint = "wbcore:directory:customerstatusrepresentation-list"
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbcore:directory:customerstatus-detail")
+
+    class Meta:
+        model = CustomerStatus
+        fields = (
+            "id",
+            "title",
+            "_detail",
+        )
+
+
+class SpecializationRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    endpoint = "wbcore:directory:specializationrepresentation-list"
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbcore:directory:specialization-detail")
+
+    class Meta:
+        model = Specialization
+        fields = (
+            "id",
+            "title",
+            "_detail",
+        )
+
+
+class EntryModelSerializer(wb_serializers.ModelSerializer):
+    last_event = wb_serializers.CharField(read_only=True)
+    activity_heat = wb_serializers.RangeSelectField(
+        color="rgb(220,20,60)", label=_("Activity Heat"), read_only=True, required=False
+    )
+    addresses_repr = wb_serializers.CharField(read_only=True)
+    customer_status = wb_serializers.CharField(
+        help_text=_(
+            "This field indicates a person's primary employer's status. It is automatically filled when the status of the primary employer is set."
+        ),
+        label=_("Customer Status"),
+        read_only=True,
+        required=False,
+    )
+    is_primary_employer = wb_serializers.BooleanField(default=False, read_only=True)
+    position_in_company = wb_serializers.CharField(
+        allow_null=True,
+        default="",
+        help_text=_(
+            "This field indicates a person's position with their primary employer. It is automatically filled when this person is assigned an employer and this person's position with that employer is filled in."
+        ),
+        label=_("Position In Company"),
+        read_only=True,
+        required=False,
+    )
+    primary_address = wb_serializers.CharField(default="", label=_("Primary Address"), read_only=True)
+    primary_email = wb_serializers.CharField(allow_null=True, default="", label=_("Primary Email"), read_only=False)
+    primary_manager_repr = wb_serializers.CharField(label=_("Primary Manager"), read_only=True)
+    primary_telephone = wb_serializers.TelephoneField(allow_null=True, default="", label=_("Primary Telephone"))
+    profile_image = wb_serializers.ImageField(allow_null=True, required=False, label=_("Profile Image"))
+    _relationship_managers = PersonRepresentationSerializer(many=True, source="relationship_managers")
+    _social_media = SocialMediaContactRepresentationSerializer(many=True, read_only=True, source="social_media")
+    primary_manager = wb_serializers.PrimaryKeyRelatedField(
+        queryset=lambda: Person.objects.filter_only_internal(),
+        default=wb_serializers.CurrentUserDefault("profile"),
+        label=_("Primary Manager"),
+        required=False,
+    )
+    _primary_manager = InternalUserProfileRepresentationSerializer(source="primary_manager")
+
+    @wb_serializers.register_resource()
+    def detail(self, instance: Entry, request, user):
+        if not (request := self.context.get("request")):
+            return
+        if instance.is_company:
+            reverse_url = reverse("wbcore:directory:company-detail", args=[instance.id], request=request)
+        else:
+            reverse_url = reverse("wbcore:directory:person-detail", args=[instance.id], request=request)
+        return {"detail": reverse_url}
+
+    @wb_serializers.register_resource()
+    def relationships(self, instance, request, user):
+        if user.has_perm("directory.view_relationship"):
+            return {
+                "relationships": reverse(
+                    "wbcore:directory:entry-relationship-list", args=[instance.id], request=request
+                )
+            }
+        return {}
+
+    @wb_serializers.register_resource()
+    def get_managers(self, instance, request, user):
+        return {
+            "manager": f"{reverse('wbcore:directory:clientmanagerrelationship-list', args=[], request=request)}?client={instance.id}"
+        }
+
+    @wb_serializers.register_resource()
+    def contacts(self, instance, request, user):
+        crms = {
+            "addresses": reverse("wbcore:directory:entry-addresscontact-list", args=[instance.id], request=request),
+            "bankings": reverse("wbcore:directory:entry-bankingcontact-list", args=[instance.id], request=request),
+            "emails": reverse("wbcore:directory:entry-emailcontact-list", args=[instance.id], request=request),
+            "telephones": reverse("wbcore:directory:entry-telephonecontact-list", args=[instance.id], request=request),
+            "social_media": reverse(
+                "wbcore:directory:entry-socialmediacontact-list", args=[instance.id], request=request
+            ),
+            "websites": reverse("wbcore:directory:entry-websitecontact-list", args=[instance.id], request=request),
+        }
+
+        return crms
+
+    def validate(self, data):
+        if primary_email := data.get("primary_email", None):
+            try:
+                validate_email(primary_email)
+            except ValidationError:
+                raise ValidationError({"primary_email": "Invalid e-mail address"})
+
+        if primary_telephone := data.get("primary_telephone", None):
+            try:
+                parser_number = phonenumbers.parse(
+                    primary_telephone, global_preferences_registry.manager()["directory__main_country_code"]
+                )
+                if parser_number:
+                    formatted_number = phonenumbers.format_number(parser_number, phonenumbers.PhoneNumberFormat.E164)
+                    data["primary_telephone"] = formatted_number
+                else:
+                    raise ValidationError({"primary_telephone": gettext("Invalid phone number format")})
+            except Exception:
+                raise ValidationError({"primary_telephone": gettext("Invalid phone number format")})
+        return super().validate(data)
+
+    def update(self, instance, validated_data):
+        if "primary_email" in validated_data.keys():
+            primary_email = validated_data.get("primary_email", None)
+            if primary_email:
+                EmailContact.set_entry_primary_email(instance, primary_email)
+            else:
+                instance.emails.filter(primary=True).delete()
+
+        if "primary_telephone" in validated_data.keys():
+            primary_telephone = validated_data.get("primary_telephone", None)
+            if primary_telephone:
+                TelephoneContact.set_entry_primary_telephone(instance, primary_telephone)
+            else:
+                instance.telephones.filter(primary=True).delete()
+        return super().update(instance, validated_data)
+
+    def create(self, validated_data: dict) -> Entry:
+        primary_email = validated_data.pop("primary_email", None)
+        primary_telephone = validated_data.pop("primary_telephone", None)
+        primary_manager = validated_data.pop("primary_manager", None)
+        instance = super().create(validated_data)
+        if primary_email:
+            EmailContact.set_entry_primary_email(instance, primary_email)
+        if primary_telephone:
+            TelephoneContact.set_entry_primary_telephone(instance, primary_telephone)
+
+        if primary_manager:
+            manager: Person = primary_manager
+        elif request := self.context.get("request"):
+            manager: Person = request.user.profile
+        else:
+            manager = None
+
+        if manager:
+            ClientManagerRelationship.objects.create(
+                client=instance,
+                relationship_manager=manager,
+                status=ClientManagerRelationship.Status.PENDINGADD,
+                primary=True,
+            )
+        return instance
+
+    class Meta:
+        model = Entry
+        read_only_fields = ("entry_type",)
+
+        fields = (
+            "last_event",
+            "id",
+            "computed_str",
+            "activity_heat",
+            "addresses",
+            "addresses_repr",
+            "customer_status",
+            "entry_type",
+            "is_draft_entry",
+            "is_primary_employer",
+            "position_in_company",
+            "primary_address",
+            "primary_email",
+            "primary_manager_repr",
+            "primary_telephone",
+            "profile_image",
+            "relationship_managers",
+            "_relationship_managers",
+            "salutation",
+            "social_media",
+            "_social_media",
+            "signature",
+            "_additional_resources",
+            "primary_manager",
+            "_primary_manager",
+        )

wbcore/contrib/directory/serializers/entry_representations.py

@@ -0,0 +1,35 @@
+from django.utils.translation import gettext_lazy as _
+from rest_framework.reverse import reverse
+from wbcore import serializers as wb_serializers
+
+from ..models import Entry
+
+
+class EntryRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    _detail = wb_serializers.SerializerMethodField()
+    _detail_preview = wb_serializers.HyperlinkField(reverse_name="wbcore:directory:entry-detail")
+    primary_email = wb_serializers.CharField(default="", label=_("Primary Email"), allow_null=True)
+    primary_telephone = wb_serializers.TelephoneField(default="", label=_("Primary Telephone"), allow_null=True)
+
+    def get__detail(self, obj):
+        if obj.is_company:
+            return reverse("wbcore:directory:company-detail", args=[obj.id], request=self.context.get("request"))
+        else:
+            return reverse("wbcore:directory:person-detail", args=[obj.id], request=self.context.get("request"))
+
+    class Meta:
+        model = Entry
+        fields = (
+            "id",
+            "computed_str",
+            "_detail",
+            "_detail_preview",
+            "primary_email",
+            "primary_telephone",
+        )
+
+
+class EntryUnlinkedRepresentationSerializer(EntryRepresentationSerializer):
+    class Meta(EntryRepresentationSerializer.Meta):
+        model = Entry
+        fields = ("id", "computed_str")

wbcore/contrib/directory/serializers/persons.py

@@ -0,0 +1,209 @@
+from django.utils.translation import gettext_lazy as _
+from rest_framework.reverse import reverse
+from wbcore import serializers as wb_serializers
+from wbcore.contrib.color.enums import WBColor
+
+from ..models import Company, EmployerEmployeeRelationship, Person, Position
+from .entries import (
+    CompanyRepresentationSerializer,
+    EntryModelSerializer,
+    SpecializationRepresentationSerializer,
+)
+from .relationships import PositionRepresentationSerializer
+
+
+class PersonModelSerializer(EntryModelSerializer):
+    activites_count = wb_serializers.IntegerField(default=0, read_only=True)
+
+    primary_employer_repr = wb_serializers.CharField(read_only=True, required=False, label=_("Primary Employer"))
+    has_user_account = wb_serializers.CharField(read_only=True, label=_("User Account"))
+    name = wb_serializers.CharField(read_only=True)
+    last_connection = wb_serializers.DateTimeField(read_only=True, default=None, label=_("Last Connection"))
+    secondary_email = wb_serializers.CharField(default="", label=_("Secondary Email"), allow_null=True, read_only=True)
+    personality_profile_red = wb_serializers.RangeSelectField(
+        color=WBColor.RED_LIGHT.value, required=False, label=_("Personality Profile Red")
+    )
+    personality_profile_green = wb_serializers.RangeSelectField(
+        color=WBColor.GREEN_LIGHT.value, required=False, label=_("Personality Profile Green")
+    )
+    personality_profile_blue = wb_serializers.RangeSelectField(
+        color=WBColor.BLUE_LIGHT.value, required=False, label=_("Personality Profile Blue")
+    )
+    _specializations = SpecializationRepresentationSerializer(source="specializations", many=True)
+    tier = wb_serializers.CharField(read_only=True, help_text=_("Tier of the primary employer"), label=_("Tier"))
+
+    def get_user_account_email(self, obj):
+        if hasattr(obj, "user_account"):
+            return obj.user_account.email
+
+    def get_user_account_last_login(self, obj):
+        if hasattr(obj, "user_account"):
+            return obj.user_account.last_login
+
+    @wb_serializers.register_resource()
+    def employers_list(self, instance, request, user):
+        return {"employers": reverse("wbcore:directory:employee-employer-list", args=[instance.id], request=request)}
+
+    @wb_serializers.register_resource()
+    def get_clients(self, instance, request, user):
+        return {
+            "client": f"{reverse('wbcore:directory:clientmanagerrelationship-list', args=[], request=request)}?relationship_manager={instance.id}&status=APPROVED"
+        }
+
+    @wb_serializers.register_resource()
+    def activity_report(self, instance, request, user):
+        return {"activity_report": None}
+
+    def create(self, validated_data):
+        instance = super().create(validated_data)
+
+        # When setting a person's employer via the DefaultFromGet in the serializer no save method gets called and the primary mixin doesn't trigger.
+        # We need to set the employer as primary manually.
+        if instance.employers.exists():
+            EmployerEmployeeRelationship.objects.filter(employee=instance, employer=instance.employers.first()).update(
+                primary=True
+            )
+        return instance
+
+    class Meta:
+        model = Person
+        read_only_fields = (
+            "activity_heat",
+            "entry_type",
+            "primary_employer",
+            "initials",
+        )
+        fields = (
+            "id",
+            "first_name",
+            "last_name",
+            "name",
+            "computed_str",
+            "active_employee",
+            "activites_count",
+            "activity_heat",
+            "addresses",
+            "addresses_repr",
+            "birthday",
+            "customer_status",
+            "entry_type",
+            "formal",
+            "has_user_account",
+            "is_draft_entry",
+            "last_connection",
+            "personality_profile_blue",
+            "personality_profile_green",
+            "personality_profile_red",
+            "position_in_company",
+            "prefix",
+            "primary_address",
+            "primary_email",
+            "primary_manager_repr",
+            "primary_employer_repr",
+            "primary_telephone",
+            "profile_image",
+            "salutation",
+            "secondary_email",
+            "specializations",
+            "_specializations",
+            "tier",
+            "_additional_resources",
+            "initials",
+        )
+
+
+class NewPersonModelSerializer(PersonModelSerializer):
+    primary_employer = wb_serializers.PrimaryKeyRelatedField(
+        read_only=False,
+        queryset=Company.objects.all(),
+        default=wb_serializers.DefaultFromGET("employers"),
+        many=False,
+        label=_("Primary Employer"),
+        required=False,
+        allow_null=True,
+    )
+    _primary_employer = CompanyRepresentationSerializer(
+        source="primary_employer",
+        many=False,
+    )
+    position_in_company = wb_serializers.PrimaryKeyRelatedField(
+        read_only=False,
+        queryset=Position.objects.all(),
+        many=False,
+        label=_("Position In Company"),
+        required=False,
+        allow_null=True,
+        depends_on=[{"field": "primary_employer", "options": {}}],
+    )
+    _position_in_company = PositionRepresentationSerializer(
+        source="position_in_company",
+        many=False,
+        depends_on=[{"field": "primary_employer", "options": {}}],
+    )
+    position_name = wb_serializers.CharField(
+        label=_("Position Name"),
+        allow_null=True,
+        required=False,
+        depends_on=[{"field": "primary_employer", "options": {}}],
+    )
+
+    def create(self, validated_data: dict) -> Person:
+        primary_employer = validated_data.pop("primary_employer", None)
+        position_in_company = validated_data.pop("position_in_company", None)
+        position_name = validated_data.pop("position_name", None)
+        validated_data.pop("employers", None)
+        instance = super().create(validated_data)
+        if primary_employer:
+            EmployerEmployeeRelationship.objects.create(
+                employee=instance,
+                employer=primary_employer,
+                primary=True,
+                position=position_in_company,
+                position_name=position_name,
+            )
+        return instance
+
+    class Meta(PersonModelSerializer.Meta):
+        model = Person
+        read_only_fields = (
+            "activity_heat",
+            "entry_type",
+            "initials",
+        )
+        fields = PersonModelSerializer.Meta.fields + (
+            "_position_in_company",
+            "primary_manager",
+            "_primary_manager",
+            "primary_employer",
+            "_primary_employer",
+            "position_name",
+        )
+
+
+class PersonModelListSerializer(PersonModelSerializer):
+    @wb_serializers.register_resource()
+    def get_managers(self, instance, request, user):
+        return {
+            "manager": f"{reverse('wbcore:directory:clientmanagerrelationship-list', args=[], request=request)}?client={instance.id}"
+        }
+
+    class Meta:
+        model = Person
+
+        fields = (
+            "id",
+            "name",
+            "activity_heat",
+            "addresses",
+            "addresses_repr",
+            "customer_status",
+            "primary_employer_repr",
+            "primary_manager_repr",
+            "last_event",
+            "position_in_company",
+            "primary_email",
+            "primary_telephone",
+            "primary_telephone",
+            "tier",
+            "_additional_resources",
+        )