Source code for shuup.admin.modules.services

from typing import Iterable

from django.utils.translation import gettext_lazy as _

from shuup.admin.base import AdminModule, MenuEntry
from shuup.admin.menu import STOREFRONT_MENU_CATEGORY
from shuup.admin.utils.object_selector import get_object_selector_permission_name
from shuup.admin.utils.urls import admin_url, derive_model_url, get_edit_and_list_urls
from shuup.core.models import Carrier, PaymentMethod, ShippingMethod



[docs]
class ServiceModule(AdminModule):
    category = _("Payment and Shipping")
    model = None
    name = None
    url_prefix = None
    view_template = None
    name_template = None
    menu_entry_url = None
    menu_ordering = 999999
    url_name_prefix = None
    icon = None


[docs]
    def get_urls(self):
        return [
            admin_url(
                rf"{self.url_prefix}/(?P<pk>\d+)/delete/$",
                self.view_template % "Delete",
                name=self.name_template % "delete",
            )
        ] + get_edit_and_list_urls(
            url_prefix=self.url_prefix,
            view_template=self.view_template,
            name_template=self.name_template,
        )



[docs]
    def get_menu_entries(self, request):
        return [
            MenuEntry(
                text=self.name,
                url=self.menu_entry_url,
                category=STOREFRONT_MENU_CATEGORY,
                ordering=self.menu_ordering,
                icon=self.icon,
            )
        ]



[docs]
    def get_model_url(self, object, kind, shop=None):
        return derive_model_url(self.model, self.url_name_prefix, object, kind)



[docs]
    def get_extra_permissions(self) -> Iterable[str]:
        return [
            get_object_selector_permission_name(Carrier),
            get_object_selector_permission_name(PaymentMethod),
            get_object_selector_permission_name(ShippingMethod),
        ]



[docs]
    def get_permissions_help_texts(self) -> Iterable[str]:
        return {
            get_object_selector_permission_name(Carrier): _("Allow the user to select carriers in admin."),
            get_object_selector_permission_name(PaymentMethod): _("Allow the user to select payment methods in admin."),
            get_object_selector_permission_name(ShippingMethod): _(
                "Allow the user to select shipping methods in admin."
            ),
        }





[docs]
class ShippingMethodModule(ServiceModule):
    model = ShippingMethod
    name = _("Shipping Methods")
    url_prefix = "^shipping_method"
    view_template = "shuup.admin.modules.services.views.ShippingMethod%sView"
    name_template = "shipping_method.%s"
    menu_entry_url = "shuup_admin:shipping_method.list"
    menu_ordering = 4
    url_name_prefix = "shuup_admin:shipping_method"
    icon = "fa fa-truck"

    breadcrumbs_menu_entry = MenuEntry(text=name, url="shuup_admin:shipping_method.list")




[docs]
class PaymentMethodModule(ServiceModule):
    model = PaymentMethod
    name = _("Payment Methods")
    url_prefix = "^payment_method"
    view_template = "shuup.admin.modules.services.views.PaymentMethod%sView"
    name_template = "payment_method.%s"
    menu_entry_url = "shuup_admin:payment_method.list"
    menu_ordering = 5
    url_name_prefix = "shuup_admin:payment_method"
    icon = "fa fa-money"

    breadcrumbs_menu_entry = MenuEntry(text=name, url="shuup_admin:payment_method.list")