ob-dj-store 0.0.22.4__tar.gz → 0.0.22.6__tar.gz

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ob-dj-store
-Version: 0.0.22.4
+Version: 0.0.22.6
 Summary: OBytes django application for managing ecommerce stores.
 Home-page: https://www.obytes.com/
 Author: OBytes

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/apis/stores/filters.py

@@ -19,6 +19,7 @@ from ob_dj_store.core.stores.models import (
     Product,
     ProductVariant,
     Store,
+    Tip,
 )
 from ob_dj_store.core.stores.models._inventory import Inventory
 from ob_dj_store.core.stores.models._wallet import Wallet
@@ -322,3 +323,17 @@ class CountryPaymentMethodFilter(filters.FilterSet):
     def by_country(self, queryset, name, value):
         if value:
             return queryset.filter(country=value)
+
+
+class TipFilter(filters.FilterSet):
+
+    country = filters.CharFilter(method="by_country")
+
+    class Meta:
+        model = Tip
+        fields = []
+
+    def by_country(self, queryset, name, value):
+        if value:
+            queryset = queryset.filter(country=value)
+        return queryset

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/apis/stores/rest/serializers/serializers.py

@@ -52,6 +52,8 @@ from ob_dj_store.core.stores.models import (
     ShippingMethod,
     Store,
     Tax,
+    Tip,
+    TipAmount,
     Wallet,
     WalletMedia,
     WalletTransaction,
@@ -284,6 +286,8 @@ class OrderSerializer(serializers.ModelSerializer):
             "created_at",
             "updated_at",
             "store_name",
+            "tip_percentage",
+            "tip_value",
         )
         extra_kwargs = {
             "customer": {"read_only": True},
@@ -614,7 +618,11 @@ class OrderSerializer(serializers.ModelSerializer):
                         attributes=list(item.attribute_choices.all()),
                         notes=item.notes,
                     )
+                if order.tip_percentage:
+                    order.tip_value = order.calculate_tip()
+                    order.save()
                 orders.append(order)
+
             amount = Decimal(
                 sum(map(lambda order: Decimal(order.total_amount) or 0, orders))
             )
@@ -1990,3 +1998,34 @@ class CountryPaymentMethodSerialzier(serializers.ModelSerializer):
             instance=qs, context=self.context, many=True
         ).data
         return data
+
+
+class TipSerializer(serializers.ModelSerializer):
+    tip_amounts = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Tip
+        fields = (
+            "id",
+            "name",
+            "description",
+            "is_applied",
+            "country",
+            "is_active",
+            "tip_amounts",
+        )
+
+    def get_tip_amounts(self, obj):
+        from .serializers import TipAmountSerializer  # avoid circular import
+
+        tip_amounts = obj.tip_amounts.all()
+        return TipAmountSerializer(tip_amounts, many=True).data
+
+
+class TipAmountSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = TipAmount
+        fields = (
+            "id",
+            "percentage",
+        )

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/apis/stores/urls.py

@@ -18,6 +18,7 @@ from ob_dj_store.apis.stores.views import (
     ShippingMethodViewSet,
     StoreView,
     TaxViewSet,
+    TipsViewSet,
     TransactionsViewSet,
     VariantView,
     WalletV2ViewSet,
@@ -54,6 +55,9 @@ router.register(
     CountryPaymentMethodsViewSet,
     basename="country-payment-methods",
 )
+router.register(
+    r"tip", TipsViewSet, basename="tip",
+)
 
 urlpatterns = [
     path(r"", include(router.urls)),

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/apis/stores/views.py

@@ -32,6 +32,7 @@ from ob_dj_store.apis.stores.filters import (
     PaymentMethodFilter,
     ProductFilter,
     StoreFilter,
+    TipFilter,
     VariantFilter,
     WalletFilter,
 )
@@ -58,6 +59,7 @@ from ob_dj_store.apis.stores.rest.serializers.serializers import (
     ShippingMethodSerializer,
     StoreSerializer,
     TaxSerializer,
+    TipSerializer,
     WalletMediaSerializer,
     WalletSerializer,
     WalletTopUpSerializer,
@@ -85,6 +87,7 @@ from ob_dj_store.core.stores.models import (
     ShippingMethod,
     Store,
     Tax,
+    Tip,
     Wallet,
     WalletMedia,
 )
@@ -1327,3 +1330,30 @@ class CountryPaymentMethodsViewSet(
     )
     def retrieve(self, request, *args, **kwargs):
         return super().retrieve(request, *args, **kwargs)
+
+
+class TipsViewSet(
+    mixins.ListModelMixin, viewsets.GenericViewSet,
+):
+    queryset = Tip.objects.active()
+    serializer_class = TipSerializer
+    filterset_class = TipFilter
+    filter_backends = [DjangoFilterBackend]
+    permission_classes = [
+        permissions.IsAuthenticated,
+    ]
+
+    def get_queryset(self):
+        return self.filter_queryset(super().get_queryset())
+
+    @swagger_auto_schema(
+        operation_summary="list al tips",
+        operation_description="""
+                list all tips
+            """,
+        tags=["Tip",],
+    )
+    def list(
+        self, request: Request, *args: typing.Any, **kwargs: typing.Any
+    ) -> Response:
+        return super().list(request=request, *args, **kwargs)

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/core/stores/admin.py

@@ -24,6 +24,7 @@ from ob_dj_store.core.stores.admin_inlines import (
     ProductAttributeInlineAdmin,
     ProductMediaInlineAdmin,
     ProductVariantInlineAdmin,
+    TipAmountInlineAdmin,
 )
 
 
@@ -535,6 +536,23 @@ class PartnerAuthInfoAdmin(admin.ModelAdmin):
     list_filter = ["authentication_expires", "partner"]
 
 
+class TipAdmin(admin.ModelAdmin):
+    list_display = (
+        "id",
+        "name",
+        "description",
+        "is_active",
+        "country",
+    )
+    search_fields = [
+        "name",
+    ]
+    list_filter = ("country",)
+    inlines = [
+        TipAmountInlineAdmin,
+    ]
+
+
 admin.site.register(models.Store, StoreAdmin)
 admin.site.register(models.ShippingMethod, ShippingMethodAdmin)
 admin.site.register(models.PaymentMethod, PaymentMethodAdmin)
@@ -559,3 +577,4 @@ admin.site.register(models.Partner, PartnerAdmin)
 admin.site.register(models.Discount, DiscountAdmin)
 admin.site.register(models.PartnerAuthInfo, PartnerAuthInfoAdmin)
 admin.site.register(models.CountryPaymentMethod, CountryPaymentMethodAdmin)
+admin.site.register(models.Tip, TipAdmin)

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/core/stores/admin_inlines.py

@@ -120,3 +120,8 @@ class InventoryOperationInlineAdmin(admin.TabularInline):
 class PartnerEmailDomainInlineAdmin(admin.TabularInline):
     model = models.PartnerEmailDomain
     extra = 1
+
+
+class TipAmountInlineAdmin(admin.TabularInline):
+    model = models.TipAmount
+    extra = 0

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/core/stores/managers.py

@@ -291,3 +291,7 @@ class PartnerAuthInfoManager(models.Manager):
 
 class CountryPaymentMethodManager(ActiveMixin, models.Manager):
     pass
+
+
+class TipManager(ActiveMixin, models.Manager):
+    pass

ob_dj_store-0.0.22.6/ob_dj_store/core/stores/migrations/0112_auto_20251027_1739.py

@@ -0,0 +1,98 @@
+# Generated by Django 3.2.8 on 2025-10-27 14:39
+
+import django.db.models.deletion
+import django_countries.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("stores", "0111_auto_20251023_1700"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Tip",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=150)),
+                ("description", models.TextField(blank=True, null=True)),
+                ("is_applied", models.BooleanField(default=True)),
+                (
+                    "country",
+                    django_countries.fields.CountryField(
+                        blank=True, default="KW", max_length=2, null=True
+                    ),
+                ),
+                ("is_active", models.BooleanField(default=False)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+            ],
+            options={"verbose_name": "Tip", "verbose_name_plural": "Tips",},
+        ),
+        migrations.AddField(
+            model_name="order",
+            name="tip_percentage",
+            field=models.DecimalField(
+                blank=True,
+                decimal_places=2,
+                help_text="Percentage value of the tip (e.g., 10 for 10%)",
+                max_digits=5,
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="order",
+            name="tip_value",
+            field=models.DecimalField(
+                blank=True, decimal_places=2, max_digits=5, null=True
+            ),
+        ),
+        migrations.CreateModel(
+            name="TipAmount",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "percentage",
+                    models.DecimalField(
+                        blank=True,
+                        decimal_places=2,
+                        help_text="Percentage value of the tip (e.g., 10 for 10%)",
+                        max_digits=5,
+                        null=True,
+                    ),
+                ),
+                (
+                    "tip",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="tip_amounts",
+                        to="stores.tip",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Tip Amount",
+                "verbose_name_plural": "Tip Amounts",
+            },
+        ),
+    ]

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/core/stores/models/__init__.py

@@ -7,7 +7,13 @@ from ob_dj_store.core.stores.models._feedback import (
     FeedbackConfig,
 )
 from ob_dj_store.core.stores.models._inventory import Inventory, InventoryOperations
-from ob_dj_store.core.stores.models._order import Order, OrderHistory, OrderItem
+from ob_dj_store.core.stores.models._order import (
+    Order,
+    OrderHistory,
+    OrderItem,
+    Tip,
+    TipAmount,
+)
 from ob_dj_store.core.stores.models._partner import (
     Discount,
     Partner,
@@ -85,4 +91,6 @@ __all__ = [
     "PartnerOTPAuth",
     "Discount",
     "CountryPaymentMethod",
+    "Tip",
+    "TipAmount",
 ]

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store/core/stores/models/_order.py

@@ -1,12 +1,13 @@
-from decimal import Decimal
+from decimal import ROUND_HALF_UP, Decimal
 
 from django.contrib.auth import get_user_model
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.core.validators import MinValueValidator
 from django.db import models
 from django.utils.translation import gettext_lazy as _
+from django_countries.fields import CountryField
 
-from ob_dj_store.core.stores.managers import OrderItemManager, OrderManager
+from ob_dj_store.core.stores.managers import OrderItemManager, OrderManager, TipManager
 from ob_dj_store.utils.model import DjangoModelCleanMixin
 
 
@@ -92,6 +93,16 @@ class Order(DjangoModelCleanMixin, models.Model):
     init_data = models.JSONField(null=True, blank=True)
     offer_redeemed = models.BooleanField(default=False)
     offer_id = models.IntegerField(null=True, blank=True, default=None)
+    tip_percentage = models.DecimalField(
+        max_digits=5,
+        decimal_places=2,
+        null=True,
+        blank=True,
+        help_text=_("Percentage value of the tip (e.g., 10 for 10%)"),
+    )
+    tip_value = models.DecimalField(
+        max_digits=5, decimal_places=2, null=True, blank=True,
+    )
     # TODO: add pick_up_time maybe ?
     # audit fields
     created_at = models.DateTimeField(auto_now_add=True)
@@ -137,6 +148,8 @@ class Order(DjangoModelCleanMixin, models.Model):
         )
         if self.shipping_method:
             amount += self.shipping_method.shipping_fee
+        if self.tip_value:
+            amount += self.tip_value
         amount -= self.get_discount_amount
         return amount
 
@@ -156,6 +169,17 @@ class Order(DjangoModelCleanMixin, models.Model):
                 return self.OrderType.WALLET.value
         return self.OrderType.PHYSICAL.value
 
+    def calculate_tip(self):
+        """
+        Returns the tip amount based on a total order amount.
+        """
+        if not self.tip_percentage:
+            return Decimal("0.00")
+        tip_value = (self.total_amount * self.tip_percentage / Decimal("100")).quantize(
+            Decimal("0.01"), rounding=ROUND_HALF_UP
+        )
+        return tip_value
+
     def save(self, **kwargs):
         if not self.pk and self.shipping_address:
             self.immutable_shipping_address = self.shipping_address.to_immutable()
@@ -277,3 +301,40 @@ class OrderHistory(DjangoModelCleanMixin, models.Model):
 
     def __str__(self):
         return f"OrderHistory - {self.status}"
+
+
+class TipAmount(models.Model):
+    percentage = models.DecimalField(
+        max_digits=5,
+        decimal_places=2,
+        null=True,
+        blank=True,
+        help_text=_("Percentage value of the tip (e.g., 10 for 10%)"),
+    )
+    tip = models.ForeignKey(
+        "Tip",
+        related_name="tip_amounts",
+        on_delete=models.CASCADE,
+        null=True,
+        blank=True,
+    )
+
+    class Meta:
+        verbose_name = _("Tip Amount")
+        verbose_name_plural = _("Tip Amounts")
+
+
+class Tip(models.Model):
+    name = models.CharField(max_length=150)
+    description = models.TextField(null=True, blank=True)
+    is_applied = models.BooleanField(default=True)
+    country = CountryField(blank=True, null=True, default="KW")
+    is_active = models.BooleanField(default=False)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    objects = TipManager()
+
+    class Meta:
+        verbose_name = _("Tip")
+        verbose_name_plural = _("Tips")

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ob-dj-store
-Version: 0.0.22.4
+Version: 0.0.22.6
 Summary: OBytes django application for managing ecommerce stores.
 Home-page: https://www.obytes.com/
 Author: OBytes

{ob_dj_store-0.0.22.4 → ob_dj_store-0.0.22.6}/ob_dj_store.egg-info/SOURCES.txt

@@ -197,6 +197,7 @@ ob_dj_store/core/stores/migrations/0108_alter_paymentmethod_payment_provider.py
 ob_dj_store/core/stores/migrations/0109_wallettransaction_cashback_type.py
 ob_dj_store/core/stores/migrations/0110_auto_20250923_1714.py
 ob_dj_store/core/stores/migrations/0111_auto_20251023_1700.py
+ob_dj_store/core/stores/migrations/0112_auto_20251027_1739.py
 ob_dj_store/core/stores/migrations/__init__.py
 ob_dj_store/core/stores/models/__init__.py
 ob_dj_store/core/stores/models/_address.py