django-quagga 0.6.1

Usage

Webhooks

Zebra handles all the webhooks that stripe sends back and calls a set of signals that you can plug your app into. To use the webhooks:

• Include the zebra urls

• Update your stripe account to point to your webhook URL (aka https://www.mysite.com/zebra/webhooks)

• Plug into any webhook signals you care about.

Note: The initial Stripe webhook system is being deprecated. See below for a description of Zebra’s support for the new system.

Zebra provides:

• zebra_webhook_recurring_payment_failed

• zebra_webhook_invoice_ready

• zebra_webhook_recurring_payment_succeeded

• zebra_webhook_subscription_trial_ending

• zebra_webhook_subscription_final_payment_attempt_failed

All of the webhooks provide the same arguments:

• customer - if ZEBRA_CUSTOMER_MODEL is set, returns an instance that matches the stripe_customer_id, or None. If ZEBRA_CUSTOMER_MODEL is not set, returns None.

• full_json - the full json response, parsed with simplejson.

So, for example, to update the customer’s new billing date after a successful payment, you could:

(assuming you’ve set ZEBRA_CUSTOMER_MODEL or are using ZEBRA_ENABLE_APP):

from zebra.signals import zebra_webhook_recurring_payment_succeeded

def update_last_invoice_date(sender, **kwargs):
    customer = kwargs.pop("customer", None)
    full_json = kwargs.pop("full_json", None)
    customer.billing_date = full_json.date
    customer.save()

zebra_webhook_recurring_payment_succeeded.connect(update_last_invoice_date)

for event_key, webhook_signal in WEBHOOK_MAP.items():
    webhook_signal.connect(webhook_logger)

Forms

The StripePaymentForm sets up a form with fields like [the official stripe example](https://gist.github.com/1204718#file_stripe_tutorial_page.html).

In particular, the form is stripped of the name attribute for any of the credit card fields, to prevent accidental submission. Media is also provided to set up stripe.js (it assumes you have jQuery).

Use it in a view like so:

if request.method == 'POST':
    zebra_form = StripePaymentForm(request.POST)
    if zebra_form.is_valid():
        my_profile = request.user.get_profile()
        stripe_customer = stripe.Customer.retrieve(my_profile.stripe_customer_id)
        stripe_customer.card = zebra_form.cleaned_data['stripe_token']
        stripe_customer.save()

        my_profile.last_4_digits = zebra_form.cleaned_data['last_4_digits']
        my_profile.stripe_customer_id = stripe_customer.id
        my_profile.save()

        # Do something kind for the user

else:
    zebra_form = StripePaymentForm()

Template Tags

There are a couple of template tags that take care of setting up the stripe env, and rendering a basic cc update form. Note that it’s expected your StripePaymentForm is called either zebra_form or form.

To use in a template:

{% extends "base.html" %}{% load zebra_tags %}

{% block head %}{{block.super}}
    {% zebra_head_and_stripe_key %}
{% endblock %}

{% block content %}
    {% zebra_card_form %}
{% endblock %}

That’s it - all the stripe tokeny goodness happens, and errors are displayed to your users.

Models and Mixins

Model and Mixin docs coming. For now, the code is pretty self-explanatory, and decently documented inline.

Other Useful Bits

Zebra comes with a manage.py command to clear out all the test customers from your account.

To use it, run:

./manage.py clear_stripe_test_customers

It responds to –verbosity=[0-3].

Credits

I did not write any of stripe. It just makes me happy to use, and inspired to make better APIs for my users. For Stripe info, ask them: [stripe.com](http://stripe.com)

Code credits are in the AUTHORS file. Pull requests welcome!

History