collective.pfg.silverpop 0.1

Addon for PloneFormGen providing Silverpop integration

Addon for PloneFormGen providing Integration of Silverpop enterprise newslettering.

Adds a FormSilverpopAdapter which can be used to create newsletter signup forms to add a recipient to a Silverpop Newsletter.

• PloneFormGen: http://pypi.python.org/pypi/Products.PloneFormGen

• Silverpop: http://www.silverpop.com/

• Code repository: http://svn.plone.org/svn/collective/collective.pfg.silverpop/tags/0.1

Known issues:

• doesn’t support unicode at the moment

Changelog

trunk

• no changes yet

0.1 (2009-04-02)

• Initial release [Hans-Peter Locher]

Introduction

This test shows how a PFG Form folder is added. We also add our custom FormSilverpopAdapter.

Setup

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.

>>> from Products.Five.testbrowser import Browser
>>> browser = Browser()
>>> 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 monkeypatch urllib to prohibit making requests to sivlerput and get test output (url, headers, data).

We use a little helper function to get pretty output:

>>> import textwrap
>>> def print_lines(text, maxwidth=70):
...     lines = textwrap.wrap(text,maxwidth)
...     for line in lines:
...         print line

We create a Fake class to be returned by urlib2.urlopen:

>>> class Fake(object):
...     def read(self): return ""

In our test method, we print request’s url, headers, data and return a Fake object:

>>> def test_urlopen(req):
...     print_lines(str(req.get_full_url()))
...     print_lines(str(req.headers))
...     print_lines(str(req.data))
...     return Fake()
>>> import urllib2

Finally we patch urllib2.urlopen:

>>> urllib2.urlopen = test_urlopen

We also define a FakeRequest class to define our request containing just a form:

>>> class FakeRequest(dict):
...   def __init__(self, **kwargs):
...     self.form = kwargs

Adding content

Add a new Form Folder:

>>> browser.getLink('Form Folder').click()
>>> browser.getControl('Title').value = 'testform'
>>> browser.getControl('Save').click()

>>> 'testform' in browser.contents
True

Go to the new Form Folder:

>>> browser.getLink('testform').click()

We use the ‘Add new’ menu to add a new content item.

>>> browser.getLink('Add new').click()

Then we select the type of item we want to add. In this case we select ‘FormSilverpopAdapter’ and click the ‘Add’ button to get to the add form.

>>> browser.getControl('FormSilverpopAdapter').click()
>>> browser.getControl(name='form.button.Add').click()
>>> 'FormSilverpopAdapter' in browser.contents
True

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'testadapter'
>>> browser.getControl('Silverpop API URL').value = 'http://url.com'
>>> browser.getControl('Silverpop List Id').value = '1'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

We added a new ‘FormSilverpopAdapter’ content item to the testform.

We could now use the browser, and configure our form till it is pleaseant for us.

For simplicity we won’t use the actual Form fields of our testform, but do some moc.

onSuccess

On submit of the form, the onSuccess method of our FormSilverpopAdapter will be called

For this test, we are going to create some fields manually, so we need the classes:

>>> from Products.PloneFormGen.content.fields import FGStringField, FGBooleanField

We also want to access our testadapter directly:

>>> self.testadapter = self.portal.testform.testadapter

CONFIRMATION

Newsletter forms usally contain some confirmation field (yes I want to get the newsletter). First we set up some fields to use later:

>>> email = FGStringField('EMAIL')
>>> email.setId('EMAIL')
>>> confirm = FGBooleanField('confirm')
>>> confirm.setId('confirm')

If the form doesn’t contain a field with id confirm, we just make a request to silverpop.

We set up the fields, here we use only one field EMAIL:

>>> fields = [email,]

We also set up a minimal request, containing the user’s input:

>>> request = FakeRequest(EMAIL='[e-mail]')

We now call the adapter’s onSuccess method:

>>> self.testadapter.onSuccess(fields,request)
http://url.com
{'Content-type': 'text/xml;charset=UTF-8'}
<Envelope><Body><AddRecipient><LIST_ID>1</LIST_ID><CREATED_FROM>2</CRE
ATED_FROM><UPDATE_IF_FOUND>true</UPDATE_IF_FOUND><COLUMN><NAME>EMAIL</
NAME><VALUE>[e-mail]</VALUE></COLUMN></AddRecipient></Body></Envelope>

The confirm field must be a boolean field, if the form contains such a confirm field and the user has checked it, we create a request to silverpop.

We set up the fields, this time with an extra confirm field:

>>> fields = [email, confirm]

We also set up a request, containing the user’s input, including the checked confirm field:

>>> request = FakeRequest(EMAIL='[e-mail]', confirm='True')

We now call the adapter’s onSuccess method, notice that we do not create xml for the confirm field, as this is only needed for our internal logic:

>>> self.testadapter.onSuccess(fields,request)
http://url.com
{'Content-type': 'text/xml;charset=UTF-8'}
<Envelope><Body><AddRecipient><LIST_ID>1</LIST_ID><CREATED_FROM>2</CRE
ATED_FROM><UPDATE_IF_FOUND>true</UPDATE_IF_FOUND><COLUMN><NAME>EMAIL</
NAME><VALUE>[e-mail]</VALUE></COLUMN></AddRecipient></Body></Envelope>

If the user hasn’t checked the confirm field, we won’t make any request. Here, the user did not check the confirm field, confirm is False:

>>> request = FakeRequest(EMAIL='[e-mail]', confirm='False')

Contributors

Hans-Peter Locher, Author

Download