wbcrm 2.2.1__py2.py3-none-any.whl

wbcrm/viewsets/groups.py

@@ -0,0 +1,37 @@
+from rest_framework.decorators import action
+from wbcore import viewsets
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    create_simple_display,
+)
+from wbcore.viewsets import RepresentationViewSet
+from wbcrm.filters import GroupFilter
+from wbcrm.models import Group
+from wbcrm.serializers import GroupModelSerializer, GroupRepresentationSerializer
+from wbcrm.viewsets.display import GroupModelDisplay
+from wbcrm.viewsets.endpoints import GroupEndpointConfig
+
+
+class GroupRepresentationViewSet(RepresentationViewSet):
+    queryset = Group.objects.all()
+    search_fields = ("title",)
+    serializer_class = GroupRepresentationSerializer
+
+
+class GroupModelViewSet(viewsets.ModelViewSet):
+    LIST_DOCUMENTATION = "wbcrm/markdown/documentation/group.md"
+    IDENTIFIER = "wbcrm:group"
+    ordering = ("title",)
+    ordering_fields = ("title", "members")
+    search_fields = ("title",)
+    filterset_class = GroupFilter
+    queryset = Group.objects.all().prefetch_related("members")
+    serializer_class = GroupModelSerializer
+    display_config_class = GroupModelDisplay
+    endpoint_config_class = GroupEndpointConfig
+
+    @action(methods=["GET"], detail=True)
+    def pre_change(self, request, pk=None):
+        return viewsets.PreAction(
+            message="Do you really want to change this?",
+            instance_display=create_simple_display([["title"]]),
+        ).to_response()

wbcrm/viewsets/menu/__init__.py

@@ -0,0 +1,8 @@
+from .accounts import ACCOUNT_MENUITEM
+from .activities import (
+    ACTIVITY_MENUTITEM,
+    ACTIVITYCHART_MENUITEM,
+    ACTIVITYTYPE_MENUITEM,
+)
+from .groups import GROUPS_MENUITEM
+from .products import PRODUCT_MENUITEM

wbcrm/viewsets/menu/accounts.py

@@ -0,0 +1,18 @@
+from wbcore.menus import ItemPermission, MenuItem
+from wbcore.permissions.shortcuts import is_internal_user
+
+ACCOUNT_MENUITEM = MenuItem(
+    label="Accounts",
+    endpoint="wbcrm:account-list",
+    endpoint_get_parameters={"parent__isnull": True},
+    permission=ItemPermission(
+        method=lambda request: is_internal_user(request.user), permissions=["wbcrm.view_account"]
+    ),
+    add=MenuItem(
+        label="Create Account",
+        endpoint="wbcrm:account-list",
+        permission=ItemPermission(
+            method=lambda request: is_internal_user(request.user), permissions=["wbcrm.add_account"]
+        ),
+    ),
+)

wbcrm/viewsets/menu/activities.py

@@ -0,0 +1,61 @@
+from datetime import timedelta
+
+from django.utils import timezone
+from django.utils.translation import gettext as _
+from wbcore.menus import ItemPermission, MenuItem
+from wbcore.permissions.shortcuts import is_internal_user
+
+
+def default_activity_create_get_params(request) -> dict:
+    return {"participants": request.user.profile.id}
+
+
+def default_activitychart_get_params(request) -> dict:
+    current_last_week_date_start = timezone.now().date() - timedelta(days=7)
+    current_next_week_date_end = timezone.now().date() + timedelta(days=7)
+
+    return {"period": f"{current_last_week_date_start:%Y-%m-%d},{current_next_week_date_end:%Y-%m-%d}"}
+
+
+ACTIVITYTYPE_MENUITEM = MenuItem(
+    label=_("Activity Types"),
+    endpoint="wbcrm:activitytype-list",
+    permission=ItemPermission(
+        method=lambda request: is_internal_user(request.user),
+        permissions=["wbcrm.view_activitytype"],
+    ),
+    add=MenuItem(
+        label=_("Create Activity Type"),
+        endpoint="wbcrm:activitytype-list",
+        permission=ItemPermission(
+            method=lambda request: is_internal_user(request.user),
+            permissions=["wbcrm.add_activitytype"],
+        ),
+    ),
+)
+
+
+ACTIVITY_MENUTITEM = MenuItem(
+    label=_("Activities"),
+    endpoint="wbcrm:activity-list",
+    permission=ItemPermission(
+        method=lambda request: is_internal_user(request.user), permissions=["wbcrm.view_activity"]
+    ),
+    # endpoint_get_parameters={"only_recent": True}, # TODO confirm that this can actually be commented out
+    add=MenuItem(
+        label=_("Create Activity"),
+        endpoint="wbcrm:activity-list",
+        permission=ItemPermission(
+            method=lambda request: is_internal_user(request.user), permissions=["wbcrm.add_activity"]
+        ),
+        endpoint_get_parameters=default_activity_create_get_params,
+    ),
+)
+ACTIVITYCHART_MENUITEM = MenuItem(
+    label=_("Activity Chart"),
+    endpoint="wbcrm:activitychart-list",
+    permission=ItemPermission(
+        method=lambda request: is_internal_user(request.user), permissions=["wbcrm.view_activity"]
+    ),
+    endpoint_get_parameters=default_activitychart_get_params,
+)

wbcrm/viewsets/menu/groups.py

@@ -0,0 +1,16 @@
+from django.utils.translation import gettext as _
+from wbcore.menus import ItemPermission, MenuItem
+from wbcore.permissions.shortcuts import is_internal_user
+
+GROUPS_MENUITEM = MenuItem(
+    label=_("Groups"),
+    endpoint="wbcrm:group-list",
+    permission=ItemPermission(method=lambda request: is_internal_user(request.user), permissions=["wbcrm.view_group"]),
+    add=MenuItem(
+        label=_("Create Groups"),
+        endpoint="wbcrm:group-list",
+        permission=ItemPermission(
+            method=lambda request: is_internal_user(request.user), permissions=["wbcrm.add_group"]
+        ),
+    ),
+)

wbcrm/viewsets/menu/products.py

@@ -0,0 +1,20 @@
+from django.utils.translation import gettext as _
+from wbcore.menus import ItemPermission, MenuItem
+from wbcore.permissions.shortcuts import is_internal_user
+
+PRODUCT_MENUITEM = MenuItem(
+    label=_("Products"),
+    endpoint="wbcrm:product-list",
+    permission=ItemPermission(
+        method=lambda request: is_internal_user(request.user),
+        permissions=["wbcrm.view_product"],
+    ),
+    add=MenuItem(
+        label=_("Create Product"),
+        endpoint="wbcrm:product-list",
+        permission=ItemPermission(
+            method=lambda request: is_internal_user(request.user),
+            permissions=["wbcrm.add_product"],
+        ),
+    ),
+)

wbcrm/viewsets/mixins.py

@@ -0,0 +1,34 @@
+from datetime import date
+
+from django.utils.functional import cached_property
+from wbcrm.models.accounts import Account, AccountRole
+
+
+class AccountPermissionMixin:
+    queryset = Account.objects.all()
+
+    @cached_property
+    def validity_date(self) -> date:
+        if validity_date_repr := self.request.GET.get("validity_date"):
+            return date.strftime(validity_date_repr, "%Y-%m-%d")
+        return date.today()
+
+    def get_queryset(self, *args, **kwargs):
+        return (
+            super().get_queryset(*args, **kwargs).filter_for_user(self.request.user, validity_date=self.validity_date)
+        )
+
+
+class AccountRolePermissionMixin:
+    queryset = AccountRole.objects.all()
+
+    @cached_property
+    def validity_date(self) -> date:
+        if validity_date_repr := self.request.GET.get("validity_date"):
+            return date.strftime(validity_date_repr, "%Y-%m-%d")
+        return date.today()
+
+    def get_queryset(self, *args, **kwargs):
+        return (
+            super().get_queryset(*args, **kwargs).filter_for_user(self.request.user, validity_date=self.validity_date)
+        )

wbcrm/viewsets/previews/__init__.py

@@ -0,0 +1 @@
+from .activities import ActivityPreviewConfig

wbcrm/viewsets/previews/activities.py

@@ -0,0 +1,10 @@
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    Display,
+    create_simple_display,
+)
+from wbcore.metadata.configs.preview import PreviewViewConfig
+
+
+class ActivityPreviewConfig(PreviewViewConfig):
+    def get_display(self) -> Display:
+        return create_simple_display([["title", "type", "result"]])

wbcrm/viewsets/products.py

@@ -0,0 +1,56 @@
+from django.db.models import F
+from wbcore import viewsets
+from wbcrm.filters.products import ProductCompanyFilterSet, ProductFilterSet
+from wbcrm.models import Product, ProductCompanyRelationship
+from wbcrm.serializers import (
+    ProductCompanyRelationshipModelSerializer,
+    ProductModelSerializer,
+    ProductRepresentationSerializer,
+)
+from wbcrm.viewsets.display import ProductCompanyRelationshipDisplay, ProductDisplay
+from wbcrm.viewsets.endpoints import ProductCompanyRelationshipEndpointConfig
+from wbcrm.viewsets.titles import ProductTitleConfig
+
+
+class ProductModelViewSet(viewsets.ModelViewSet):
+    IDENTIFIER = "wbcrm:product"
+    LIST_DOCUMENTATION = "wbcrm/markdown/documentation/product.md"
+    queryset = Product.objects.all()
+    serializer_class = ProductModelSerializer
+    display_config_class = ProductDisplay
+    title_config_class = ProductTitleConfig
+    search_fields = ("title",)
+
+    filterset_class = ProductFilterSet
+    ordering_fields = ("title",)
+    ordering = ["title", "is_competitor"]
+
+
+class ProductCompanyRelationshipCompanyModelViewSet(viewsets.ModelViewSet):
+    IDENTIFIER = "wbcrm:company-interestedproduct"
+    queryset = ProductCompanyRelationship.objects.all()
+    serializer_class = ProductCompanyRelationshipModelSerializer
+    display_config_class = ProductCompanyRelationshipDisplay
+    title_config_class = ProductTitleConfig
+    endpoint_config_class = ProductCompanyRelationshipEndpointConfig
+    search_fields = ("product__title",)
+    ordering_fields = ("product__title",)
+    ordering = ("product__title", "company__name")
+    filterset_class = ProductCompanyFilterSet
+
+    def get_queryset(self):
+        qs = (
+            super()
+            .get_queryset()
+            .filter(company=self.kwargs["company_id"])
+            .annotate(competitor_product=F("product__is_competitor"))
+        )
+        return qs
+
+
+class ProductRepresentationViewSet(viewsets.RepresentationViewSet):
+    IDENTIFIER = "wbcrm:productrepresentation"
+    serializer_class = ProductRepresentationSerializer
+    search_fields = ("title",)
+    queryset = Product.objects.all()
+    ordering = ("title", "is_competitor")

wbcrm/viewsets/recurrence.py

@@ -0,0 +1,26 @@
+from django.contrib.messages import warning
+from django.shortcuts import get_object_or_404
+from django.utils.translation import gettext as _
+from rest_framework import permissions
+from rest_framework.decorators import action
+from rest_framework.response import Response
+from wbcrm.models.recurrence import Recurrence
+
+
+class RecurrenceModelViewSetMixin:
+    @action(detail=True, methods=["DELETE"], permission_classes=[permissions.IsAuthenticated])
+    def delete_next_occurrences(self, request, pk=None):
+        instance = get_object_or_404(self.queryset.model, pk=pk)
+        instance.forward_deletion()
+        return Response({})
+
+    def add_messages(self, request, instance=None, **kwargs):
+        if instance:
+            # If true, this activity is recurring.
+            if instance.is_recurrent:
+                warning(
+                    request,
+                    _("This is a recurring occurrence with period {repeat_choice}").format(
+                        repeat_choice=Recurrence.ReoccuranceChoice(instance.repeat_choice).label
+                    ),
+                )

wbcrm/viewsets/titles/__init__.py

@@ -0,0 +1,13 @@
+from wbcrm.viewsets.titles.activities import (
+    ActivityChartModelTitleConfig,
+    ActivityParticipantTitleConfig,
+    ActivityTitleConfig,
+    ActivityTypeTitleConfig,
+)
+
+from .accounts import (
+    AccountRoleAccountTitleConfig,
+    AccountTitleConfig,
+    ChildAccountAccountTitleConfig,
+)
+from .products import ProductTitleConfig

wbcrm/viewsets/titles/accounts.py

@@ -0,0 +1,22 @@
+from wbcore.metadata.configs.titles import TitleViewConfig
+from wbcrm.models.accounts import Account
+
+
+class AccountTitleConfig(TitleViewConfig):
+    def get_instance_title(self):
+        return "Account: {{title}}"
+
+    def get_list_title(self):
+        return "Accounts"
+
+
+class ChildAccountAccountTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        account = Account.objects.get(id=self.view.kwargs["account_id"])
+        return f"{account.title}: Sub Accounts"
+
+
+class AccountRoleAccountTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        account = Account.objects.get(id=self.view.kwargs["account_id"])
+        return f"Roles for Account {str(account)}"

wbcrm/viewsets/titles/activities.py

@@ -0,0 +1,61 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class ActivityTypeTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Activity Types")
+
+    def get_create_title(self):
+        return _("New Activity Type")
+
+    def get_instance_title(self):
+        return _("Activity Type")
+
+
+class ActivityTitleConfig(TitleViewConfig):
+    def get_instance_title(self):
+        if "pk" in self.view.kwargs:
+            if self.view.is_private_for_user:
+                return _("Private Activity")
+
+            elif self.view.is_confidential_for_user:
+                return _("Confidential Activity")
+
+        return _("Activity: {{title}}")
+
+    def get_delete_title(self):
+        if "pk" in self.view.kwargs:
+            if self.view.is_private_for_user:
+                return _("Delete Private Activity")
+
+            elif self.view.is_confidential_for_user:
+                return _("Delete Confidential Activity")
+
+        return _("Delete Activity: {{title}}")
+
+    def get_list_title(self):
+        if self.view.participants.exists():
+            if self.view.participants.count() == 1:
+                return _("Activities for {person}").format(person=str(self.view.participants.first()))
+            else:
+                return _("Activities for Multiple Persons")
+
+        if self.view.companies.exists():
+            return _("Activities for {}").format(", ".join(self.view.companies.values_list("name", flat=True)))
+        return _("Activities")
+
+    def get_create_title(self):
+        if self.view.entry:
+            return _("New Activity for {entry}").format(entry=self.view.entry.computed_str)
+        return _("New Activity")
+
+
+class ActivityParticipantTitleConfig(TitleViewConfig):
+    def get_instance_title(self):
+        return _("Participation Status")
+
+
+class ActivityChartModelTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Activity Chart")

wbcrm/viewsets/titles/products.py

@@ -0,0 +1,13 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class ProductTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Products")
+
+    def get_create_title(self):
+        return _("Add Product")
+
+    def get_instance_title(self):
+        return _("Product")

wbcrm/viewsets/titles/utils.py

@@ -0,0 +1,46 @@
+from django.utils.translation import gettext as _
+from wbcore.metadata.configs.titles import TitleViewConfig
+
+
+class CustomerStatusTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Customer Statuses")
+
+    def get_create_title(self):
+        return _("New Customer Status")
+
+    def get_instance_title(self):
+        return _("Customer Status")
+
+
+class PositionTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Company Positions")
+
+    def get_create_title(self):
+        return _("New Company Position")
+
+    def get_instance_title(self):
+        return _("Company Position")
+
+
+class CompanyTypeTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Company Types")
+
+    def get_create_title(self):
+        return _("New Company Type")
+
+    def get_instance_title(self):
+        return _("Company Type")
+
+
+class SpecializationTitleConfig(TitleViewConfig):
+    def get_list_title(self):
+        return _("Specializations")
+
+    def get_create_title(self):
+        return _("New Specialization")
+
+    def get_instance_title(self):
+        return _("Specialization")

wbcrm/workflows/__init__.py

@@ -0,0 +1 @@
+from .assignee_methods import *

wbcrm/workflows/assignee_methods.py

@@ -0,0 +1,25 @@
+from django.utils.translation import gettext as _
+from wbcore.contrib.authentication.models import User
+from wbcore.contrib.directory.models import Person
+from wbcore.contrib.workflow.decorators import register_assignee
+from wbcore.contrib.workflow.models import ProcessStep
+
+# We need to migrate upon name changes!
+
+
+# TODO: Generalize this through field filter
+@register_assignee("Activity Assignee")
+def activity_assignee(process_step: ProcessStep, **kwargs) -> User | None:
+    if hasattr(process_step.process.instance, "assigned_to"):
+        assignee: Person = getattr(process_step.process.instance, "assigned_to")
+        if hasattr(assignee, "user_account"):
+            return assignee.user_account
+        else:
+            error_message = _("Assignee has no user account!")
+    else:
+        error_message = _("No activity attached!")
+
+    process_step.step.get_casted_step().set_failed(
+        process_step, _("Error in assignee method: {}").format(error_message)
+    )
+    return None

wbcrm-2.2.1.dist-info/METADATA

@@ -0,0 +1,11 @@
+Metadata-Version: 2.3
+Name: wbcrm
+Version: 2.2.1
+Summary: A workbench module that contains all the functionality related to a customer relationship management.
+Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
+Requires-Dist: django-eventtools==1.*
+Requires-Dist: google-api-python-client==2.62.*
+Requires-Dist: google-auth-httplib2==0.1.*
+Requires-Dist: google-auth-oauthlib==0.5.*
+Requires-Dist: wbcore
+Requires-Dist: xlsxwriter==3.*