uncloud-mravi/uncloud/uncloud_pay/models.py

192 lines
6.4 KiB
Python
Raw Normal View History

2020-02-27 10:21:38 +00:00
from django.db import models
from django.contrib.auth import get_user_model
from django.core.validators import MinValueValidator
from django.utils.translation import gettext_lazy as _
2020-02-29 08:08:30 +00:00
from django.utils import timezone
2020-02-27 10:21:38 +00:00
import uuid
2020-02-27 10:21:38 +00:00
AMOUNT_MAX_DIGITS=10
AMOUNT_DECIMALS=2
2020-02-27 10:21:38 +00:00
# See https://docs.djangoproject.com/en/dev/ref/models/fields/#field-choices-enum-types
class RecurringPeriod(models.TextChoices):
ONE_TIME = 'ONCE', _('Onetime')
PER_YEAR = 'YEAR', _('Per Year')
PER_MONTH = 'MONTH', _('Per Month')
PER_MINUTE = 'MINUTE', _('Per Minute')
PER_DAY = 'DAY', _('Per Day')
PER_HOUR = 'HOUR', _('Per Hour')
PER_SECOND = 'SECOND', _('Per Second')
2020-02-27 10:21:38 +00:00
class Bill(models.Model):
uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
2020-02-27 10:21:38 +00:00
owner = models.ForeignKey(get_user_model(),
2020-02-27 14:50:46 +00:00
on_delete=models.CASCADE)
2020-02-27 10:21:38 +00:00
creation_date = models.DateTimeField(auto_now_add=True)
2020-02-27 10:21:38 +00:00
starting_date = models.DateTimeField()
ending_date = models.DateTimeField()
due_date = models.DateField()
valid = models.BooleanField(default=True)
@property
2020-02-29 08:08:30 +00:00
def entries(self):
# TODO: return list of Bill entries, extract from linked order
# for each related order
# for each product
# build BillEntry
return []
2020-02-27 10:21:38 +00:00
2020-02-29 08:08:30 +00:00
@property
def total(self):
#return helpers.sum_amounts(self.entries)
pass
class BillEntry():
start_date = timezone.now()
end_date = timezone.now()
recurring_period = RecurringPeriod.PER_MONTH
recurring_price = 0
amount = 0
description = ""
# /!\ BIG FAT WARNING /!\ #
#
# Order are assumed IMMUTABLE and used as SOURCE OF TRUST for generating
# bills. Do **NOT** mutate then!
#
# Why? We need to store the state somewhere since product are mutable (e.g.
# adding RAM to VM, changing price of 1GB of RAM, ...). An alternative could
# have been to only store the state in bills but would have been more
# confusing: the order is a 'contract' with the customer, were both parts
# agree on deal => That's what we want to keep archived.
#
# SOON:
#
# We'll need to add some kind of OrderEntry table (each order might have
# multiple entries) storing: recurring_price, recurring_period, setup_fee, description
#
# FOR NOW:
#
# We dynamically get pricing from linked product, as they are not updated in
# this stage of development.
#
# /!\ BIG FAT WARNING /!\ #
2020-02-27 10:21:38 +00:00
class Order(models.Model):
uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
owner = models.ForeignKey(get_user_model(),
on_delete=models.CASCADE,
editable=False)
creation_date = models.DateTimeField(auto_now_add=True)
2020-02-27 19:58:12 +00:00
starting_date = models.DateTimeField(auto_now_add=True)
2020-02-27 10:21:38 +00:00
ending_date = models.DateTimeField(blank=True,
null=True)
bill = models.ManyToManyField(Bill,
editable=False,
blank=True)
2020-02-27 10:21:38 +00:00
recurring_period = models.CharField(max_length=32,
choices = RecurringPeriod.choices,
default = RecurringPeriod.PER_MONTH)
2020-02-27 10:21:38 +00:00
2020-02-29 08:08:30 +00:00
2020-02-27 10:21:38 +00:00
# def amount(self):
# amount = recurring_price
# if recurring and first_month:
# amount += one_time_price
# return amount # you get the picture
class PaymentMethod(models.Model):
uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
owner = models.ForeignKey(get_user_model(),
on_delete=models.CASCADE,
editable=False)
source = models.CharField(max_length=256,
choices = (
('stripe', 'Stripe'),
('unknown', 'Unknown'),
),
default='stripe')
description = models.TextField()
primary = models.BooleanField(default=True)
2020-02-27 14:50:46 +00:00
def charge(self, amount):
2020-02-28 08:26:18 +00:00
if amount > 0: # Make sure we don't charge negative amount by errors...
if self.source == 'stripe':
# TODO: wire to strip, see meooow-payv1/strip_utils.py
payment = Payment(owner=self.owner, source=self.source, amount=amount)
payment.save() # TODO: Check return status
return True
else:
# We do not handle that source yet.
return False
else:
return False
2020-02-27 14:50:46 +00:00
class Meta:
unique_together = [['owner', 'primary']]
2020-02-27 10:21:38 +00:00
class Payment(models.Model):
uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
owner = models.ForeignKey(get_user_model(),
2020-02-27 14:50:46 +00:00
on_delete=models.CASCADE)
2020-02-27 10:21:38 +00:00
amount = models.DecimalField(
default=0.0,
max_digits=AMOUNT_MAX_DIGITS,
decimal_places=AMOUNT_DECIMALS,
2020-02-27 10:21:38 +00:00
validators=[MinValueValidator(0)])
source = models.CharField(max_length=256,
choices = (
('wire', 'Wire Transfer'),
2020-02-27 11:21:52 +00:00
('stripe', 'Stripe'),
2020-02-27 10:21:38 +00:00
('voucher', 'Voucher'),
('referral', 'Referral'),
('unknown', 'Unknown')
),
default='unknown')
2020-02-28 08:26:18 +00:00
timestamp = models.DateTimeField(editable=False, auto_now_add=True)
class Product(models.Model):
uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
owner = models.ForeignKey(get_user_model(),
on_delete=models.CASCADE,
editable=False)
description = ""
status = models.CharField(max_length=256,
choices = (
('pending', 'Pending'),
('being_created', 'Being created'),
('active', 'Active'),
('deleted', 'Deleted')
),
default='pending'
)
order = models.ForeignKey(Order,
on_delete=models.CASCADE,
editable=False,
null=True)
@property
def recurring_price(self, recurring_period=RecurringPeriod.PER_MONTH):
pass # To be implemented in child.
@property
def setup_fee(self):
return 0
class Meta:
abstract = True