signup_codes.markdown

signup_codes

for pinax 0.7.1

Code for django-notification is online at GitHub: http://github.com/pinax/pinax/tree/0.7.1/pinax/apps/signup_codes

Data Model

• Dependencies:

  • django.contrib.auth
  • account

• SignupCode

  • code (char 40)

  • max_uses (int)

  • expiry (datetime)

  • inviter (foreign-key -> django.contrib.auth.models.User)

  • email (email)

  • notes (text)

  • created (datetime)

  • use_count (int) calculated

  • Methods - SignupCode...

    • calculate_use_count(self)

    • use(self, user)

      Add a SignupCode result attached to the given user.

• SignupCodeResult

  • signup_code (foreign-key -> SignupCode)
  • user (foreign-key -> django.contrib.auth.models.User)
  • timestamp (datetime)

• Methods (signup_code.models...)

  • check_signup_code(code)

    returns a boolean if the signup code is valid

URL Design

url(r'^admin/invite_user/$', 'signup_codes.views.admin_invite_user', name="admin_invite_user"),
url(r'^account/signup/$', signup_view, name="acct_signup"),

Views & Templates

• signup(request, form_class=SignupForm, template_name="account/signup.html", success_url=None)

  • default template: account/signup.html
  • context
    • code
    • form

• admin_invite_user(request, form_class=InviteUserForm, template_name="signup_codes/admin_invite_user.html")

  • uses @staff_member_required

  This view, by default, works inside the Django admin.

  • default template: signup_codes/admin_invite_user.html
  • context:
    • title
    • form

• Embedded Default Templates

  • from pinax
    • signup_codes/admin_invite_user.html http://github.com/pinax/pinax/blob/0.7.1/pinax/templates/default/signup_codes/admin_invite_user.html
    • signup_codes/failure.html http://github.com/pinax/pinax/blob/0.7.1/pinax/templates/default/signup_codes/failure.html
    • signup_codes/invite_user.txt http://github.com/pinax/pinax/blob/0.7.1/pinax/templates/default/signup_codes/invite_user.txt

TemplateTags

None

Filters

None

View Decorators

None

Forms

• SignupForm (account.SignupForm)

  • signup_code

• InviteUserForm

  • email

Constants

• settings.ACCOUNT_OPEN_SIGNUP