apps/funding/models.py

   1 # -*- coding: utf-8 -*-
   2 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   3 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   4 #
   5 from datetime import date, datetime
   6 from django.core.urlresolvers import reverse
   7 from django.db import models
   8 from django.utils.translation import ugettext_lazy as _, ugettext as __
   9 import getpaid
  10 from catalogue.models import Book
  11
  12
  13 class Offer(models.Model):
  14     """ A fundraiser for a particular book. """
  15     author = models.CharField(_('author'), max_length=255)
  16     title = models.CharField(_('title'), max_length=255)
  17     slug = models.SlugField(_('slug'))
  18     description = models.TextField(_('description'), blank=True)
  19     target = models.DecimalField(_('target'), decimal_places=2, max_digits=10)
  20     start = models.DateField(_('start'))
  21     end = models.DateField(_('end'))
  22     due = models.DateField(_('due'),
  23         help_text=_('When will it be published if the money is raised.'))
  24     redakcja_url = models.URLField(_('redakcja URL'), blank=True)
  25     book = models.ForeignKey(Book, null=True, blank=True,
  26         help_text=_('Published book.'))
  27
  28     class Meta:
  29         verbose_name = _('offer')
  30         verbose_name_plural = _('offers')
  31         ordering = ['-end']
  32
  33     def __unicode__(self):
  34         return u"%s - %s" % (self.author, self.title)
  35
  36     def get_absolute_url(self):
  37         return reverse('funding_offer', args=[self.slug])
  38
  39     def is_current(self):
  40         return self.start <= date.today() <= self.end
  41
  42     def is_win(self):
  43         return self.sum() >= self.target
  44
  45     def remaining(self):
  46         if self.is_current():
  47             return None
  48         if self.is_win():
  49             return self.sum() - self.target
  50         else:
  51             return self.sum()
  52
  53     @classmethod
  54     def current(cls):
  55         """ Returns current fundraiser or None. """
  56         today = date.today()
  57         objects = cls.objects.filter(start__lte=today, end__gte=today)
  58         try:
  59             return objects[0]
  60         except IndexError:
  61             return None
  62
  63     @classmethod
  64     def past(cls):
  65         """ QuerySet for all current and past fundraisers. """
  66         today = date.today()
  67         return cls.objects.filter(end__lt=today)
  68
  69     @classmethod
  70     def public(cls):
  71         """ QuerySet for all current and past fundraisers. """
  72         today = date.today()
  73         return cls.objects.filter(start__lte=today)
  74
  75     def get_perks(self, amount=None):
  76         """ Finds all the perks for the offer.
  77
  78         If amount is provided, returns the perks you get for it.
  79
  80         """
  81         perks = Perk.objects.filter(
  82                 models.Q(offer=self) | models.Q(offer=None)
  83             ).exclude(end_date__lt=date.today())
  84         if amount is not None:
  85             perks = perks.filter(price__lte=amount)
  86         return perks
  87
  88     def funding_payed(self):
  89         """ QuerySet for all completed payments for the offer. """
  90         return Funding.payed().filter(offer=self)
  91
  92     def sum(self):
  93         """ The money gathered. """
  94         return self.funding_payed().aggregate(s=models.Sum('amount'))['s'] or 0
  95
  96
  97 class Perk(models.Model):
  98     """ A perk offer.
  99
 100     If no attached to a particular Offer, applies to all.
 101
 102     """
 103     offer = models.ForeignKey(Offer, verbose_name=_('offer'), null=True, blank=True)
 104     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
 105     name = models.CharField(_('name'), max_length=255)
 106     description = models.TextField(_('description'), blank=True)
 107     end_date = models.DateField(_('end date'), null=True, blank=True)
 108
 109     class Meta:
 110         verbose_name = _('perk')
 111         verbose_name_plural = _('perks')
 112         ordering = ['-price']
 113
 114     def __unicode__(self):
 115         return "%s (%s%s)" % (self.name, self.price, u" for %s" % self.offer if self.offer else "")
 116
 117
 118 class Funding(models.Model):
 119     """ A person paying in a fundraiser.
 120
 121     The payment was completed if and only if payed_at is set.
 122
 123     """
 124     offer = models.ForeignKey(Offer, verbose_name=_('offer'))
 125     name = models.CharField(_('name'), max_length=127, blank=True)
 126     email = models.EmailField(_('email'), blank=True)
 127     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
 128     payed_at = models.DateTimeField(_('payed at'), null=True, blank=True)
 129     perks = models.ManyToManyField(Perk, verbose_name=_('perks'), blank=True)
 130
 131     # Any additional info needed for perks?
 132
 133     @classmethod
 134     def payed(cls):
 135         """ QuerySet for all completed payments. """
 136         return cls.objects.exclude(payed_at=None)
 137
 138     class Meta:
 139         verbose_name = _('funding')
 140         verbose_name_plural = _('fundings')
 141         ordering = ['-payed_at']
 142
 143     def __unicode__(self):
 144         return unicode(self.offer)
 145
 146     def get_absolute_url(self):
 147         return reverse('funding_funding', args=[self.pk])
 148
 149 # Register the Funding model with django-getpaid for payments.
 150 getpaid.register_to_payment(Funding, unique=False, related_name='payment')
 151
 152
 153 class Spent(models.Model):
 154     """ Some of the remaining money spent on a book. """
 155     book = models.ForeignKey(Book)
 156     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
 157     timestamp = models.DateField(_('when'))
 158
 159     class Meta:
 160         verbose_name = _('money spent on a book')
 161         verbose_name_plural = _('money spent on books')
 162         ordering = ['-timestamp']
 163
 164     def __unicode__(self):
 165         return u"Spent: %s" % unicode(self.book)
 166
 167
 168 def new_payment_query_listener(sender, order=None, payment=None, **kwargs):
 169     """ Set payment details for getpaid. """
 170     payment.amount = order.amount
 171     payment.currency = 'PLN'
 172 getpaid.signals.new_payment_query.connect(new_payment_query_listener)
 173
 174
 175 def user_data_query_listener(sender, order, user_data, **kwargs):
 176     """ Set user data for payment. """
 177     user_data['email'] = order.email
 178 getpaid.signals.user_data_query.connect(user_data_query_listener)
 179
 180 def payment_status_changed_listener(sender, instance, old_status, new_status, **kwargs):
 181     """ React to status changes from getpaid. """
 182     if old_status != 'paid' and new_status == 'paid':
 183         instance.order.payed_at = datetime.now()
 184         instance.order.save()
 185 getpaid.signals.payment_status_changed.connect(payment_status_changed_listener)