Summary

Add the recaptcha module

Review Request #7937 — Created Feb. 2, 2016 and submitted Feb. 5, 2016, 9:44 a.m.

Information

Owner

brennie

Repository

Djblets

Branch

release-0.10.x

Bugs

Depends On

Blocks

7938

Commit

aa8ef6c...

Reviewers

Groups

djblets

People

Description

The djblets.recaptcha module provides a form mixin that supports
reCAPTCHA API version 2.

reCAPTCHA is an implementation of CAPTCHA (Completely Automated
Public Turing Test to tell Computers and Humans Apart) by Google.
It is used in web forms to prevent them from being filled out and
submitted by automated bots.

Testing Done


Used this with Splat.
Ran unit tests.
Built and viewed the docs.

Issues

Description	From	Last Updated
Col: 1 W391 blank line at end of file	reviewbot	Feb. 2, 2016, 3:35 a.m.
Can you extend this to say how it's used? Might also be nice to include a reference to the guide.	chipx86	Feb. 3, 2016, 1:38 a.m.
"reCAPTCHA"	chipx86	Feb. 2, 2016, 7:57 a.m.
Maybe we should say to contact an administrator.	chipx86	Feb. 2, 2016, 7:57 a.m.
Let's check for a KeyError on access, in case we somehow get something we don't expect.	chipx86	Feb. 2, 2016, 8:04 a.m.
Can we call this recaptcha_form_field?	chipx86	Feb. 2, 2016, 8:04 a.m.
In case we decide to backport any of this (wouldn't be bad to have in a 2.5), we should use …	chipx86	Feb. 2, 2016, 8:04 a.m.
This file is intended only for built-in Django settings. Maybe we want a Djblets equivalent, but I think we should …	chipx86	Feb. 2, 2016, 8:07 a.m.
Space before <.	chipx86	Feb. 2, 2016, 8:06 a.m.
It'd be cool to have a little example showing a form's HTML and mixing in. Though it's easy to do, …	chipx86	Feb. 3, 2016, 1:38 a.m.
Trailing blank line.	chipx86	Feb. 2, 2016, 8:07 a.m.
'settings' imported but unused	reviewbot	Feb. 3, 2016, 1:42 a.m.
'format_html' imported but unused	reviewbot	Feb. 3, 2016, 1:43 a.m.
With logging.exception you don't need to format the exception into the log string. This should also be "reCAPTCHA", not "ReCaptcha"	david	Feb. 4, 2016, 8:46 a.m.
With logging.exception you don't need to format the exception into the log string.	david	Feb. 4, 2016, 8:46 a.m.
Too many blank lines here.	david	Feb. 4, 2016, 8:47 a.m.
IIRC the description should go on the next line.	david	Feb. 5, 2016, 9:44 a.m.

Tool: PEP8 Style Checker
Processed Files:
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/apps.py

Ignored Files:
    docs/djblets/coderef/index.rst



Tool: Pyflakes
Processed Files:
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/apps.py

Ignored Files:
    docs/djblets/coderef/index.rst

djblets/recaptcha/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 1
 W391 blank line at end of file
```

Change Summary:

PEP8

Diff:

Revision 2 (+130)

Show changes

	djblets/recaptcha/__init__.py
	djblets/recaptcha/apps.py
	djblets/recaptcha/mixins.py
	djblets/siteconfig/django_settings.py
	docs/djblets/coderef/index.rst

Tool: Pyflakes
Processed Files:
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/apps.py

Ignored Files:
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/apps.py

Ignored Files:
    docs/djblets/coderef/index.rst

Change Summary:

Use key names from RB

Diff:

Revision 3 (+130)

Show changes

	djblets/recaptcha/__init__.py
	djblets/recaptcha/apps.py
	djblets/recaptcha/mixins.py
	djblets/siteconfig/django_settings.py
	docs/djblets/coderef/index.rst

Tool: Pyflakes
Processed Files:
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/apps.py

Ignored Files:
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/apps.py

Ignored Files:
    docs/djblets/coderef/index.rst

Change Summary:

Add docs.

Fix siteconfig settings

Diff:

Revision 4 (+200)

Show changes

	djblets/recaptcha/__init__.py
	djblets/recaptcha/apps.py
	djblets/recaptcha/mixins.py
	djblets/recaptcha/templatetags/__init__.py
	djblets/recaptcha/templatetags/djblets_recaptcha.py
	djblets/siteconfig/django_settings.py
	docs/djblets/coderef/index.rst
	docs/djblets/guides/index.rst
	2 more

Tool: PEP8 Style Checker
Processed Files:
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/apps.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst



Tool: Pyflakes
Processed Files:
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/apps.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst

Awesome :)

Some thoughts, mostly doc/error-related.

djblets/recaptcha/mixins.py (Diff revision 4)

The issue has been resolved. Show all issues

Can you extend this to say how it's used? Might also be nice to include a reference to the guide.

djblets/recaptcha/mixins.py (Diff revision 4)
The issue has been resolved. Show all issues
```
"reCAPTCHA"
```
djblets/recaptcha/mixins.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Maybe we should say to contact an administrator.
```

djblets/recaptcha/mixins.py (Diff revision 4)

The issue has been resolved. Show all issues

Let's check for a KeyError on access, in case we somehow get something we don't expect.

djblets/recaptcha/templatetags/djblets_recaptcha.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Can we call this recaptcha_form_field?
```

djblets/recaptcha/templatetags/djblets_recaptcha.py (Diff revision 4)

The issue has been resolved. Show all issues

In case we decide to backport any of this (wouldn't be bad to have in a 2.5), we should use {0} instead of {}, as the latter breaks on Python 2.6.

djblets/siteconfig/django_settings.py (Diff revision 4)

The issue has been resolved. Show all issues

This file is intended only for built-in Django settings. Maybe we want a Djblets equivalent, but I think we should do what djblets.log does, where there's a siteconfig.py in djblets.recaptcha that provides the settings map and lets the caller use it.

docs/djblets/guides/recaptcha/using-recaptcha.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
Space before <.
```

docs/djblets/guides/recaptcha/using-recaptcha.rst (Diff revision 4)

The issue has been resolved. Show all issues

It'd be cool to have a little example showing a form's HTML and mixing in. Though it's easy to do, having it as reference will be useful.

Also, an example with using this in a SiteConfiguration would be good.

docs/djblets/guides/recaptcha/using-recaptcha.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
Trailing blank line.
```

Oh also, can you add more to the description for the commit? There's not much info on what this is for, especially if you don't know reCAPTCHA.

Change Summary:

Address Christian's issues

Diff:

Revision 5 (+382 -1)

Show changes

	djblets/recaptcha/__init__.py
	djblets/recaptcha/apps.py
	djblets/recaptcha/mixins.py
	djblets/recaptcha/siteconfig.py
	djblets/recaptcha/widgets.py
	djblets/recaptcha/templatetags/__init__.py
	djblets/recaptcha/templatetags/djblets_recaptcha.py
	djblets/siteconfig/django_settings.py
	4 more

Tool: Pyflakes
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst

djblets/recaptcha/templatetags/djblets_recaptcha.py (Diff revision 5)
The issue has been resolved. Show all issues
```
 'settings' imported but unused
```
djblets/recaptcha/templatetags/djblets_recaptcha.py (Diff revision 5)
The issue has been resolved. Show all issues
```
 'format_html' imported but unused
```

Description:: The djblets.recaptcha module provides a form mixin that supports
reCAPTCHA API version 2.
+
+
reCAPTCHA is an implementation of CAPTCHA (Completely Automated
+ Public Turing Test to tell Computers and Humans Apart) by Google.
+ It is used in web forms to prevent them from being filled out and
+ submitted by automated bots.

Change Summary:

PEP8

Diff:

Revision 6 (+382 -1)

Show changes

	djblets/recaptcha/__init__.py
	djblets/recaptcha/apps.py
	djblets/recaptcha/mixins.py
	djblets/recaptcha/siteconfig.py
	djblets/recaptcha/widgets.py
	djblets/recaptcha/templatetags/__init__.py
	djblets/recaptcha/templatetags/djblets_recaptcha.py
	djblets/siteconfig/django_settings.py
	4 more

Tool: Pyflakes
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst

Testing Done:: Used this with Splat.

Ran unit tests.
+
Built and viewed the docs.

Diff:

Revision 7 (+381 -1)

Show changes

	djblets/recaptcha/__init__.py
	djblets/recaptcha/apps.py
	djblets/recaptcha/mixins.py
	djblets/recaptcha/siteconfig.py
	djblets/recaptcha/widgets.py
	djblets/recaptcha/templatetags/__init__.py
	djblets/recaptcha/templatetags/djblets_recaptcha.py
	djblets/siteconfig/django_settings.py
	4 more

Tool: Pyflakes
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/siteconfig/django_settings.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst

Change Summary:

Add removed line

Diff:

Revision 8 (+381)

Show changes

	djblets/recaptcha/__init__.py
	djblets/recaptcha/apps.py
	djblets/recaptcha/mixins.py
	djblets/recaptcha/siteconfig.py
	djblets/recaptcha/widgets.py
	djblets/recaptcha/templatetags/__init__.py
	djblets/recaptcha/templatetags/djblets_recaptcha.py
	docs/djblets/coderef/index.rst
	3 more

Tool: Pyflakes
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst

djblets/recaptcha/mixins.py (Diff revision 8)

The issue has been resolved. Show all issues

With logging.exception you don't need to format the exception into the log string. This should also be "reCAPTCHA", not "ReCaptcha"

djblets/recaptcha/mixins.py (Diff revision 8)

The issue has been resolved. Show all issues

With logging.exception you don't need to format the exception into the log string.

docs/djblets/guides/recaptcha/using-recaptcha.rst (Diff revision 8)
The issue has been resolved. Show all issues
```
Too many blank lines here.
```

Change Summary:

Addressed David's issues

Diff:

Revision 9 (+382)

Show changes

	djblets/recaptcha/__init__.py
	djblets/recaptcha/apps.py
	djblets/recaptcha/mixins.py
	djblets/recaptcha/siteconfig.py
	djblets/recaptcha/widgets.py
	djblets/recaptcha/templatetags/__init__.py
	djblets/recaptcha/templatetags/djblets_recaptcha.py
	docs/djblets/coderef/index.rst
	3 more

Tool: PEP8 Style Checker
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst



Tool: Pyflakes
Processed Files:
    djblets/recaptcha/siteconfig.py
    djblets/recaptcha/apps.py
    djblets/recaptcha/__init__.py
    djblets/recaptcha/mixins.py
    djblets/recaptcha/templatetags/djblets_recaptcha.py
    djblets/recaptcha/widgets.py

Ignored Files:
    docs/djblets/guides/recaptcha/index.rst
    docs/djblets/guides/recaptcha/using-recaptcha.rst
    docs/djblets/guides/index.rst
    djblets/recaptcha/templatetags/__init__.py
    docs/djblets/coderef/index.rst

Ship it!

djblets/recaptcha/mixins.py (Diff revision 9)
The issue has been resolved. Show all issues
```
IIRC the description should go on the next line.
```

Status:: Completed
Change Summary:: Pushed to release-0.10.x (142da51)

		The `djblets.recaptcha` module provides a form mixin that supports
		reCAPTCHA API version 2.
	+
	+	reCAPTCHA is an implementation of CAPTCHA (Completely Automated
	+	Public Turing Test to tell Computers and Humans Apart) by Google.
	+	It is used in web forms to prevent them from being filled out and
	+	submitted by automated bots.

		Used this with Splat.
		Ran unit tests.
	+	Built and viewed the docs.