[tor-commits] [bridgedb/develop] Add class inheritance overview to bridgedb.captcha module docstring.

[isis at torproject.org]

commit 65be217961a833951497931dc0b77074da38fc13
Author: Isis Lovecruft <isis at torproject.org>
Date:   Wed May 14 20:33:10 2014 +0000

    Add class inheritance overview to bridgedb.captcha module docstring.
---
 lib/bridgedb/captcha.py |   26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/lib/bridgedb/captcha.py b/lib/bridgedb/captcha.py
index 8f56552..0018988 100644
--- a/lib/bridgedb/captcha.py
+++ b/lib/bridgedb/captcha.py
@@ -17,10 +17,30 @@
 
 **Module Overview:**
 
-..
+::
+
   captcha
-   |_ReCaptchaKeyError
-   \_ReCaptcha - Class for obtaining reCaptcha images and challenge strings
+   |- CaptchaExpired - Raised if a solution is given for a stale CAPTCHA.
+   |- CaptchaKeyError - Raised if a CAPTCHA system's keys are invalid/missing.
+   |- GimpCaptchaError - Raised when a Gimp CAPTCHA can't be retrieved.
+   |
+   \_ ICaptcha - Zope Interface specification for a generic CAPTCHA.
+        |
+      Captcha - Generic base class implementation for obtaining a CAPTCHA.
+      |  |- image - The CAPTCHA image.
+      |  |- challenge - A unique string associated with this CAPTCHA image.
+      |  |- publicKey - The public key for this CAPTCHA system.
+      |  |- secretKey - The secret key for this CAPTCHA system.
+      |   \_ get() - Get a new pair of CAPTCHA image and challenge strings.
+      |
+      |- ReCaptcha - Obtain reCaptcha images and challenge strings.
+      |   \_ get() - Request an image and challenge from a reCaptcha API server.
+      |
+      \_ GimpCaptcha - Class for obtaining a CAPTCHA from a local cache.
+          |- hmacKey - A client-specific key for HMAC generation.
+          |- cacheDir - The path to the local CAPTCHA cache directory.
+          \_ get() - Get a CAPTCHA image from the cache and create a challenge.
+
 ..
 
 There are two types of CAPTCHAs which BridgeDB knows how to serve: those