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'), db_index=True)
  21     end = models.DateField(_('end'), db_index=True)
  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     cover = models.ImageField(_('cover'), upload_to = 'funding/covers')
  28
  29     def cover_img_tag(self):
  30         return u'<img src="%s" />' % self.cover.url
  31     cover_img_tag.short_description = _('Cover preview')
  32     cover_img_tag.allow_tags = True
  33
  34     class Meta:
  35         verbose_name = _('offer')
  36         verbose_name_plural = _('offers')
  37         ordering = ['-end']
  38
  39     def __unicode__(self):
  40         return u"%s - %s" % (self.author, self.title)
  41
  42     def get_absolute_url(self):
  43         return reverse('funding_offer', args=[self.slug])
  44
  45     def is_current(self):
  46         return self.start <= date.today() <= self.end
  47
  48     def is_win(self):
  49         return self.sum() >= self.target
  50
  51     def remaining(self):
  52         if self.is_current():
  53             return None
  54         if self.is_win():
  55             return self.sum() - self.target
  56         else:
  57             return self.sum()
  58
  59     @classmethod
  60     def current(cls):
  61         """ Returns current fundraiser or None. """
  62         today = date.today()
  63         objects = cls.objects.filter(start__lte=today, end__gte=today)
  64         try:
  65             return objects[0]
  66         except IndexError:
  67             return None
  68
  69     @classmethod
  70     def past(cls):
  71         """ QuerySet for all current and past fundraisers. """
  72         today = date.today()
  73         return cls.objects.filter(end__lt=today)
  74
  75     @classmethod
  76     def public(cls):
  77         """ QuerySet for all current and past fundraisers. """
  78         today = date.today()
  79         return cls.objects.filter(start__lte=today)
  80
  81     def get_perks(self, amount=None):
  82         """ Finds all the perks for the offer.
  83
  84         If amount is provided, returns the perks you get for it.
  85
  86         """
  87         perks = Perk.objects.filter(
  88                 models.Q(offer=self) | models.Q(offer=None)
  89             ).exclude(end_date__lt=date.today())
  90         if amount is not None:
  91             perks = perks.filter(price__lte=amount)
  92         return perks
  93
  94     def funding_payed(self):
  95         """ QuerySet for all completed payments for the offer. """
  96         return Funding.payed().filter(offer=self)
  97
  98     def sum(self):
  99         """ The money gathered. """
 100         return self.funding_payed().aggregate(s=models.Sum('amount'))['s'] or 0
 101
 102
 103 class Perk(models.Model):
 104     """ A perk offer.
 105
 106     If no attached to a particular Offer, applies to all.
 107
 108     """
 109     offer = models.ForeignKey(Offer, verbose_name=_('offer'), null=True, blank=True)
 110     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
 111     name = models.CharField(_('name'), max_length=255)
 112     description = models.TextField(_('description'), blank=True)
 113     end_date = models.DateField(_('end date'), null=True, blank=True)
 114
 115     class Meta:
 116         verbose_name = _('perk')
 117         verbose_name_plural = _('perks')
 118         ordering = ['-price']
 119
 120     def __unicode__(self):
 121         return "%s (%s%s)" % (self.name, self.price, u" for %s" % self.offer if self.offer else "")
 122
 123
 124 class Funding(models.Model):
 125     """ A person paying in a fundraiser.
 126
 127     The payment was completed if and only if payed_at is set.
 128
 129     """
 130     offer = models.ForeignKey(Offer, verbose_name=_('offer'))
 131     name = models.CharField(_('name'), max_length=127, blank=True)
 132     email = models.EmailField(_('email'), blank=True)
 133     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
 134     payed_at = models.DateTimeField(_('payed at'), null=True, blank=True, db_index=True)
 135     perks = models.ManyToManyField(Perk, verbose_name=_('perks'), blank=True)
 136
 137     # Any additional info needed for perks?
 138
 139     @classmethod
 140     def payed(cls):
 141         """ QuerySet for all completed payments. """
 142         return cls.objects.exclude(payed_at=None)
 143
 144     class Meta:
 145         verbose_name = _('funding')
 146         verbose_name_plural = _('fundings')
 147         ordering = ['-payed_at']
 148
 149     def __unicode__(self):
 150         return unicode(self.offer)
 151
 152     def get_absolute_url(self):
 153         return reverse('funding_funding', args=[self.pk])
 154
 155 # Register the Funding model with django-getpaid for payments.
 156 getpaid.register_to_payment(Funding, unique=False, related_name='payment')
 157
 158
 159 class Spent(models.Model):
 160     """ Some of the remaining money spent on a book. """
 161     book = models.ForeignKey(Book)
 162     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
 163     timestamp = models.DateField(_('when'))
 164
 165     class Meta:
 166         verbose_name = _('money spent on a book')
 167         verbose_name_plural = _('money spent on books')
 168         ordering = ['-timestamp']
 169
 170     def __unicode__(self):
 171         return u"Spent: %s" % unicode(self.book)
 172
 173
 174 def new_payment_query_listener(sender, order=None, payment=None, **kwargs):
 175     """ Set payment details for getpaid. """
 176     payment.amount = order.amount
 177     payment.currency = 'PLN'
 178 getpaid.signals.new_payment_query.connect(new_payment_query_listener)
 179
 180
 181 def user_data_query_listener(sender, order, user_data, **kwargs):
 182     """ Set user data for payment. """
 183     user_data['email'] = order.email
 184 getpaid.signals.user_data_query.connect(user_data_query_listener)
 185
 186 def payment_status_changed_listener(sender, instance, old_status, new_status, **kwargs):
 187     """ React to status changes from getpaid. """
 188     if old_status != 'paid' and new_status == 'paid':
 189         instance.order.payed_at = datetime.now()
 190         instance.order.save()
 191 getpaid.signals.payment_status_changed.connect(payment_status_changed_listener)