Add django-getpaid
authorRadek Czajka <radoslaw.czajka@nowoczesnapolska.org.pl>
Wed, 17 Apr 2013 09:46:30 +0000 (11:46 +0200)
committerRadek Czajka <radoslaw.czajka@nowoczesnapolska.org.pl>
Wed, 17 Apr 2013 09:46:30 +0000 (11:46 +0200)
apps/funding/forms.py
apps/funding/migrations/0005_auto__chg_field_funding_payed_at.py [new file with mode: 0644]
apps/funding/models.py
apps/funding/templates/funding/funding_detail.html [new file with mode: 0755]
apps/funding/templates/funding/offer_detail.html
apps/funding/urls.py
apps/funding/views.py
requirements.txt
wolnelektury/settings/__init__.py

index 6b2316e..c66211a 100755 (executable)
@@ -1,20 +1,20 @@
 from django import forms
 from django.utils.translation import ugettext_lazy as _, ugettext as __
-from .models import Offer
+from .models import Funding
 from .widgets import PerksAmountWidget
 
 
 class DummyForm(forms.Form):
     required_css_class = 'required'
 
-    name = forms.CharField(label=_("Name"))
+    amount = forms.DecimalField(label=_("Amount"), decimal_places=2,
+        widget=PerksAmountWidget())
+    name = forms.CharField(label=_("Name"), required=False)
     anonymous = forms.BooleanField(label=_("Anonymously"),
         required=False,
         help_text=_("Check if you don't want your name to be visible publicly."))
     email = forms.EmailField(label=_("E-mail"),
-        help_text=_("Won't be publicised."))
-    amount = forms.DecimalField(label=_("Amount"), decimal_places=2,
-        widget=PerksAmountWidget())
+        help_text=_("Won't be publicised."), required=False)
 
     def __init__(self, offer, *args, **kwargs):
         self.offer = offer
@@ -32,7 +32,8 @@ class DummyForm(forms.Form):
         return self.cleaned_data
 
     def save(self):
-        return self.offer.fund(
+        return Funding.objects.create(
+            offer=self.offer,
             name=self.cleaned_data['name'],
             email=self.cleaned_data['email'],
             amount=self.cleaned_data['amount'],
diff --git a/apps/funding/migrations/0005_auto__chg_field_funding_payed_at.py b/apps/funding/migrations/0005_auto__chg_field_funding_payed_at.py
new file mode 100644 (file)
index 0000000..bcd4e1e
--- /dev/null
@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+
+        # Changing field 'Funding.payed_at'
+        db.alter_column(u'funding_funding', 'payed_at', self.gf('django.db.models.fields.DateTimeField')(null=True))
+
+    def backwards(self, orm):
+
+        # Changing field 'Funding.payed_at'
+        db.alter_column(u'funding_funding', 'payed_at', self.gf('django.db.models.fields.DateTimeField')(default=datetime.datetime(2013, 4, 16, 0, 0)))
+
+    models = {
+        'catalogue.book': {
+            'Meta': {'ordering': "('sort_key',)", 'object_name': 'Book'},
+            '_related_info': ('jsonfield.fields.JSONField', [], {'null': 'True', 'blank': 'True'}),
+            'changed_at': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'db_index': 'True', 'blank': 'True'}),
+            'common_slug': ('django.db.models.fields.SlugField', [], {'max_length': '120'}),
+            'cover': ('catalogue.fields.EbookField', [], {'max_length': '100', 'null': 'True', 'format_name': "'cover'", 'blank': 'True'}),
+            'created_at': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'db_index': 'True', 'blank': 'True'}),
+            'description': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            'epub_file': ('catalogue.fields.EbookField', [], {'default': "''", 'max_length': '100', 'format_name': "'epub'", 'blank': 'True'}),
+            'extra_info': ('jsonfield.fields.JSONField', [], {'default': "'{}'"}),
+            'fb2_file': ('catalogue.fields.EbookField', [], {'default': "''", 'max_length': '100', 'format_name': "'fb2'", 'blank': 'True'}),
+            'gazeta_link': ('django.db.models.fields.CharField', [], {'max_length': '240', 'blank': 'True'}),
+            'html_file': ('catalogue.fields.EbookField', [], {'default': "''", 'max_length': '100', 'format_name': "'html'", 'blank': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'language': ('django.db.models.fields.CharField', [], {'default': "'pol'", 'max_length': '3', 'db_index': 'True'}),
+            'mobi_file': ('catalogue.fields.EbookField', [], {'default': "''", 'max_length': '100', 'format_name': "'mobi'", 'blank': 'True'}),
+            'parent': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'children'", 'null': 'True', 'to': "orm['catalogue.Book']"}),
+            'parent_number': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'pdf_file': ('catalogue.fields.EbookField', [], {'default': "''", 'max_length': '100', 'format_name': "'pdf'", 'blank': 'True'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'unique': 'True', 'max_length': '120'}),
+            'sort_key': ('django.db.models.fields.CharField', [], {'max_length': '120', 'db_index': 'True'}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '120'}),
+            'txt_file': ('catalogue.fields.EbookField', [], {'default': "''", 'max_length': '100', 'format_name': "'txt'", 'blank': 'True'}),
+            'wiki_link': ('django.db.models.fields.CharField', [], {'max_length': '240', 'blank': 'True'}),
+            'xml_file': ('catalogue.fields.EbookField', [], {'default': "''", 'max_length': '100', 'format_name': "'xml'", 'blank': 'True'})
+        },
+        u'funding.funding': {
+            'Meta': {'ordering': "['-payed_at']", 'object_name': 'Funding'},
+            'amount': ('django.db.models.fields.DecimalField', [], {'max_digits': '10', 'decimal_places': '2'}),
+            'anonymous': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '127', 'blank': 'True'}),
+            'offer': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['funding.Offer']"}),
+            'payed_at': ('django.db.models.fields.DateTimeField', [], {'null': 'True', 'blank': 'True'}),
+            'perks': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['funding.Perk']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        u'funding.offer': {
+            'Meta': {'ordering': "['-end']", 'object_name': 'Offer'},
+            'author': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'book': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.Book']", 'null': 'True', 'blank': 'True'}),
+            'due': ('django.db.models.fields.DateField', [], {}),
+            'end': ('django.db.models.fields.DateField', [], {}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'redakcja_url': ('django.db.models.fields.URLField', [], {'max_length': '200', 'blank': 'True'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'max_length': '50'}),
+            'start': ('django.db.models.fields.DateField', [], {}),
+            'target': ('django.db.models.fields.DecimalField', [], {'max_digits': '10', 'decimal_places': '2'}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '255'})
+        },
+        u'funding.perk': {
+            'Meta': {'ordering': "['-price']", 'object_name': 'Perk'},
+            'description': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'offer': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['funding.Offer']", 'null': 'True', 'blank': 'True'}),
+            'price': ('django.db.models.fields.DecimalField', [], {'max_digits': '10', 'decimal_places': '2'})
+        },
+        u'funding.spent': {
+            'Meta': {'ordering': "['-timestamp']", 'object_name': 'Spent'},
+            'amount': ('django.db.models.fields.DecimalField', [], {'max_digits': '10', 'decimal_places': '2'}),
+            'book': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.Book']"}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'timestamp': ('django.db.models.fields.DateField', [], {})
+        }
+    }
+
+    complete_apps = ['funding']
\ No newline at end of file
index 579147c..1024313 100644 (file)
@@ -2,14 +2,16 @@
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
+from datetime import date, datetime
 from django.core.urlresolvers import reverse
 from django.db import models
 from django.utils.translation import ugettext_lazy as _, ugettext as __
-from datetime import date, datetime
+import getpaid
 from catalogue.models import Book
 
 
 class Offer(models.Model):
+    """ A fundraiser for a particular book. """
     author = models.CharField(_('author'), max_length=255)
     title = models.CharField(_('title'), max_length=255)
     slug = models.SlugField(_('slug'))
@@ -38,6 +40,7 @@ class Offer(models.Model):
 
     @classmethod
     def current(cls):
+        """ Returns current fundraiser or None. """
         today = date.today()
         objects = cls.objects.filter(start__lte=today, end__gte=today)
         try:
@@ -47,10 +50,16 @@ class Offer(models.Model):
 
     @classmethod
     def public(cls):
+        """ QuerySet for all current and past fundraisers. """
         today = date.today()
         return cls.objects.filter(start__lte=today)        
 
     def get_perks(self, amount=None):
+        """ Finds all the perks for the offer.
+        
+        If amount is provided, returns the perks you get for it.
+
+        """
         perks = Perk.objects.filter(
                 models.Q(offer=self) | models.Q(offer=None)
             )
@@ -58,16 +67,13 @@ class Offer(models.Model):
             perks = perks.filter(price__lte=amount)
         return perks
 
-    def fund(self, name, email, amount, anonymous=False):
-        funding = self.funding_set.create(
-            name=name, email=email, amount=amount,
-            anonymous=anonymous,
-            payed_at=datetime.now())
-        funding.perks = self.get_perks(amount)
-        return funding
+    def funding_payed(self):
+        """ QuerySet for all completed payments for the offer. """
+        return Funding.payed().filter(offer=self)
 
     def sum(self):
-        return self.funding_set.aggregate(s=models.Sum('amount'))['s'] or 0
+        """ The money gathered. """
+        return self.funding_payed().aggregate(s=models.Sum('amount'))['s'] or 0
 
     def state(self):
         if self.sum() >= self.target:
@@ -79,6 +85,11 @@ class Offer(models.Model):
 
 
 class Perk(models.Model):
+    """ A perk offer.
+    
+    If no attached to a particular Offer, applies to all.
+
+    """
     offer = models.ForeignKey(Offer, verbose_name=_('offer'), null=True, blank=True)
     price = models.DecimalField(_('price'), decimal_places=2, max_digits=10)
     name = models.CharField(_('name'), max_length=255)
@@ -94,14 +105,24 @@ class Perk(models.Model):
 
 
 class Funding(models.Model):
+    """ A person paying in a fundraiser.
+
+    The payment was completed if and only if payed_at is set.
+
+    """
     offer = models.ForeignKey(Offer, verbose_name=_('offer'))
-    name = models.CharField(_('name'), max_length=127)
-    email = models.EmailField(_('email'))
+    name = models.CharField(_('name'), max_length=127, blank=True)
+    email = models.EmailField(_('email'), blank=True)
     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
-    payed_at = models.DateTimeField(_('payed at'))
+    payed_at = models.DateTimeField(_('payed at'), null=True, blank=True)
     perks = models.ManyToManyField(Perk, verbose_name=_('perks'), blank=True)
     anonymous = models.BooleanField(_('anonymous'))
 
+    @classmethod
+    def payed(cls):
+        """ QuerySet for all completed payments. """
+        return cls.objects.exclude(payed_at=None)
+
     class Meta:
         verbose_name = _('funding')
         verbose_name_plural = _('fundings')
@@ -110,8 +131,15 @@ class Funding(models.Model):
     def __unicode__(self):
         return "%s payed %s for %s" % (self.name, self.amount, self.offer)
 
+    def get_absolute_url(self):
+        return reverse('funding_funding', args=[self.pk])
+
+# Register the Funding model with django-getpaid for payments.
+getpaid.register_to_payment(Funding, unique=False, related_name='payment')
+
 
 class Spent(models.Model):
+    """ Some of the remaining money spent on a book. """
     amount = models.DecimalField(_('amount'), decimal_places=2, max_digits=10)
     timestamp = models.DateField(_('when'))
     book = models.ForeignKey(Book)
@@ -123,3 +151,18 @@ class Spent(models.Model):
 
     def __unicode__(self):
         return u"Spent: %s" % unicode(self.book)
+
+
+def new_payment_query_listener(sender, order=None, payment=None, **kwargs):
+    """ Set payment details for getpaid. """
+    payment.amount = order.amount
+    payment.currency = 'PLN'
+getpaid.signals.new_payment_query.connect(new_payment_query_listener)
+
+
+def payment_status_changed_listener(sender, instance, old_status, new_status, **kwargs):
+    """ React to status changes from getpaid. """
+    if old_status != 'paid' and new_status == 'paid':
+        instance.order.payed_at = datetime.now()
+        instance.order.save()
+getpaid.signals.payment_status_changed.connect(payment_status_changed_listener)
diff --git a/apps/funding/templates/funding/funding_detail.html b/apps/funding/templates/funding/funding_detail.html
new file mode 100755 (executable)
index 0000000..617426d
--- /dev/null
@@ -0,0 +1,53 @@
+{% extends "base.html" %}
+{% load i18n %}
+{% load funding_tags %}
+{% load fnp_share %}
+
+
+{% block titleextra %}
+    {% if object.payed_at %}
+        {% trans "Thank you!" %}
+    {% else %}
+        {{ object }}
+    {% endif %}
+{% endblock %}
+
+
+{% block body %}
+
+
+{% if object.payed_at %}
+
+<h1>{% trans "Thank you!" %}</h1>
+<div class="white-box normal-text">
+
+{% trans "Thank you for your support!" %}
+
+
+
+{% url 'funding_current' as current %}
+<p><a href="{{ current }}">{% trans "Go back to the current fundraiser." %}</a></p>
+
+{% url 'funding_current' as current %}
+<p>{% share current 'y' %}</p>
+
+</div>
+
+
+
+{% else %}
+
+
+<h1>{{ object }}</h1>
+
+<div class="white-box normal-text">
+<form action="{% url 'getpaid-new-payment' currency='PLN' %}" method="post">
+    {% csrf_token %}
+    {{ payment_form.as_p }}
+    <input type="submit" value="Continue">
+</form>
+</div>
+
+
+{% endif %}
+{% endblock %}
index 81007b0..c7405ca 100755 (executable)
@@ -41,7 +41,7 @@
 <div class="white-box normal-text">
     
     <table class="wlfund">
-    {% for funding in object.funding_set.all %}
+    {% for funding in object.funding_payed.all %}
         <tr class="funding-plus">
             <td><div>{{ funding.payed_at.date }}</div></td>
             <td><div>
index 7aed8dc..c930c60 100755 (executable)
@@ -2,16 +2,18 @@
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
-from django.conf.urls import patterns, url
+from django.conf.urls import patterns, url, include
 
 from .models import Offer
-from .views import WLFundView, OfferDetailView, ThanksView, OfferListView
+from .views import (WLFundView, OfferDetailView, OfferListView,
+                FundingView)
 
 
 urlpatterns = patterns('',
     url(r'^$', OfferDetailView.as_view(), name='funding_current'),
     url(r'^lektura/$', OfferListView.as_view(), name='funding'),
     url(r'^lektura/(?P<slug>[^/]+)/$', OfferDetailView.as_view(), name='funding_offer'),
-    url(r'^dziekujemy/$', ThanksView.as_view(), name='funding_thanks'),
+    url(r'^wplata/(?P<pk>\d+)/$', FundingView.as_view(), name='funding_funding'),
     url(r'^fundusz/$', WLFundView.as_view(), name='funding_wlfund'),
+    url(r'^getpaid/', include('getpaid.urls')),
 )
index 3ea68b5..047be49 100644 (file)
@@ -2,13 +2,16 @@
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
+from django.views.decorators.cache import never_cache
 from django.conf import settings
 from django.core.urlresolvers import reverse
 from django.http import Http404
 from django.shortcuts import redirect, get_object_or_404
+from django.utils.decorators import method_decorator
 from django.views.generic import TemplateView, FormView, DetailView, ListView
+from getpaid.forms import PaymentMethodForm
 from .forms import DummyForm
-from .models import Offer, Spent
+from .models import Offer, Spent, Funding
 
 
 def mix(*streams):
@@ -91,11 +94,12 @@ class OfferDetailView(FormView):
         ctx['object'] = self.object
         if self.object.is_current():
             ctx['funding_no_show_current'] = True
+            ctx['payment_form'] = PaymentMethodForm('PLN', initial={'order': self.object})
         return ctx
 
     def form_valid(self, form):
-        form.save()
-        return redirect(reverse("funding_thanks"))
+        funding = form.save()
+        return redirect(funding.get_absolute_url())
 
 
 class OfferListView(ListView):
@@ -107,10 +111,17 @@ class OfferListView(ListView):
         return ctx
 
 
-class ThanksView(TemplateView):
-    template_name = "funding/thanks.html"
+class FundingView(DetailView):
+    model = Funding
+
+    @method_decorator(never_cache)
+    def dispatch(self, *args, **kwargs):
+        return super(FundingView, self).dispatch(*args, **kwargs)
 
     def get_context_data(self, *args, **kwargs):
-        ctx = super(ThanksView, self).get_context_data(*args, **kwargs)
-        ctx['object'] = Offer.current()
+        ctx = super(FundingView, self).get_context_data(*args, **kwargs)
+        if self.object.offer.is_current():
+            ctx['funding_no_show_current'] = True
+            ctx['payment_form'] = PaymentMethodForm('PLN', initial={'order': self.object})
         return ctx
+
index 7ccdb73..784e85a 100644 (file)
@@ -43,7 +43,7 @@ lxml>=2.2.2
 # MySQL-python>=1.2,<2.0
 
 # celery tasks
-django-celery>=2.5.1
+django-celery>=3.0.11
 django-kombu
 
 # spell checking
@@ -54,3 +54,5 @@ pyoai
 
 egenix-mx-base
 sunburnt
+
+django-getpaid
index 7b1641c..8403688 100644 (file)
@@ -70,6 +70,11 @@ INSTALLED_APPS_OUR = [
     'funding',
     ]
 
+GETPAID_BACKENDS = (
+    'getpaid.backends.dummy',
+    'getpaid.backends.payu',
+)
+
 INSTALLED_APPS_CONTRIB = [
     # external
     'django.contrib.auth',
@@ -91,6 +96,9 @@ INSTALLED_APPS_CONTRIB = [
     'honeypot',
     #'django_nose',
     'fnpdjango',
+    'getpaid',
+    'getpaid.backends.dummy',
+    'getpaid.backends.payu',
 
     #allauth stuff
     'uni_form',