Metadata-Version: 1.0
Name: collective.recaptchawidget
Version: 0.5
Summary: A simple widget that uses collective.recaptcha for Archetypes
Home-page: http://svn.plone.org/svn/collective/
Author: Carlos de la Guardia
Author-email: cguardia@yahoo.com
License: GPL
Description: .. contents::
        
        This is a simple widget and field for Archetypes that uses
        collective.recaptcha to show a captcha in any archetypes-based content
        type. Changes to the content type will not be saved if the captcha code
        entered by the user is incorrect.
        
        To use it, simple define a field in your archetypes schema that looks
        like this example:
        
        RecaptchaedContentSchema = atapi.Schema((
        
        atapi.TextField(
        'Text',
        storage=atapi.AnnotationStorage(),
        widget=atapi.TextAreaWidget(
        label=_(u"Text"),
        description=_(u"Field description"),
        ),
        required=True,
        ),
        
        CaptchaField(
        'captcha',
        ),
        
        ))
        
        
        - Code repository: http://svn.plone.org/svn/collective/collective.recaptchawidget
        - Questions and comments to plone users list.
        
        
        Change history
        **************
        
        Changelog
        =========
        
        0.1 (xxxx-xx-xx)
        ----------------
        
        - Created recipe with ZopeSkel
        [Carlos de la Guardia]
        
        Detailed Documentation
        **********************
        
        Introduction
        ============
        
        This is a full-blown functional test. The emphasis here is on testing what
        the user may input and see, and the system is largely tested as a black box.
        We use PloneTestCase to set up this test as well, so we have a full Plone site
        to play with. We *can* inspect the state of the portal, e.g. using
        self.portal and self.folder, but it is often frowned upon since you are not
        treating the system as a black box. Also, if you, for example, log in or set
        roles using calls like self.setRoles(), these are not reflected in the test
        browser, which runs as a separate session.
        
        Being a doctest, we can tell a story here.
        
        First, we must perform some setup. We use the testbrowser that is shipped
        with Five, as this provides proper Zope 2 integration. Most of the
        documentation, though, is in the underlying zope.testbrower package.
        
        The first thing we set up are the keys that the recaptcha service requires to
        work from our server. You will need to get your own keys at recaptcha.net and
        insert them here.
        
        >>> public_key = "6LfGLgwAAAAAADC8ksGViFzAF0-DWxCm3dnWBqA2"
        >>> private_key = "6LfGLgwAAAAAADipA71BqVmpV37yk3L1r0gXPldp"
        
        Next, we set up the test browser.
        
        >>> from Products.Five.testbrowser import Browser
        >>> browser = Browser()
        >>> browser.handleErrors = False
        >>> portal_url = self.portal.absolute_url()
        
        The following is useful when writing and debugging testbrowser tests. It lets
        us see all error messages in the error_log.
        
        >>> self.portal.error_log._ignored_exceptions = ()
        
        With that in place, we can go to the portal front page and log in. We will
        do this using the default user from PloneTestCase:
        
        >>> from Products.PloneTestCase.setup import portal_owner, default_password
        
        >>> browser.open(portal_url)
        
        We have the login portlet, so let's use that.
        
        >>> browser.getControl(name='__ac_name').value = portal_owner
        >>> browser.getControl(name='__ac_password').value = default_password
        >>> browser.getControl(name='submit').click()
        
        Here, we set the value of the fields on the login form and then simulate a
        submit click.
        
        We then test that we are still on the portal front page:
        
        >>> browser.url == portal_url
        True
        
        And we ensure that we get the friendly logged-in message:
        
        >>> "You are now logged in" in browser.contents
        True
        
        
        -*- extra stuff goes here -*-
        The Recaptchaed Content content type
        ===============================
        
        In this section we are tesing the Recaptchaed Content content type by performing
        basic operations like adding, updadating and deleting Recaptchaed Content content
        items.
        
        Configuring the recaptcha keys
        ------------------------------
        
        Before using the recaptcha field and widget, we have to configure the recaptcha
        service using the control panel provided by collective.recaptcha. To do that,
        we use the keys defined at the start of the tests.
        
        >>> browser.open("%s/@@recaptcha-settings" % portal_url)
        >>> browser.getControl(name='form.public_key').value = public_key
        >>> browser.getControl(name='form.private_key').value = private_key
        >>> browser.getControl(name='form.actions.apply').click()
        
        Adding a new Recaptchaed Content content item
        --------------------------------
        
        We go back to the initial page and use the 'Add new' menu to add a new content item.
        
        >>> browser.open(portal_url)
        >>> browser.getLink('Add new').click()
        
        Then we select the type of item we want to add. In this case we select
        'Recaptchaed Content' and click the 'Add' button to get to the add form.
        
        >>> browser.getControl('Recaptchaed Content').click()
        >>> browser.getControl(name='form.button.Add').click()
        >>> 'Recaptchaed Content' in browser.contents
        True
        
        Now we fill the form and submit it.
        
        >>> browser.getControl(name='title').value = 'Recaptchaed Content Sample'
        >>> browser.getControl(name='Text').value = 'Recaptchaed Content Text'
        
        But we ignore the captcha field, so the save should fail.
        
        >>> browser.getControl('Save').click()
        >>> 'Changes saved' in browser.contents
        False
        >>> 'incorrect-captcha-sol' in browser.contents
        True
        
        Not sure about a way to test a successful captcha edit, since from a test we
        can't see the words...will think about this.
        
        
        
        
        Contributors
        ************
        
        Carlos de la Guardia, Author
        
        
        Download
        ********
        
Platform: UNKNOWN
Classifier: Framework :: Plone
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
