Personal tools
You are here: Home → Eggs → uwosh.meeting
 

uwosh.meeting

a folderish Event-ish content type that helps manage all information related to meetings

Current release
uwosh.meeting 0.6.3

Released Mar 03, 2013

Download file Get uwosh.meeting for All platforms (36.6 kB)
uwosh.meeting-0.6.3.tar.gz

Project Description

Contents

To get Meeting objects to show on your calendar portlet: in the ZMI of the site, go to portal_calendar -> Configure tab, then in the "Portal Types to show in the calendar" list, Control-click or Command-click the Meeting type so that both Event and Meeting types are selected. Then press Submit at the bottom of the page.

Remember: the calendar portlet will show only PUBLISHED items, as per that Configure tab's default settings, so if you want a Meeting (or an Event) to show up in the portlet, the Meeting or Event must be published too.

This product also depends on Products.ATBackRef to support bidirectional relations between connected Meeting objects (next/previous). Add the following to your buildout.cfg eggs:

Products.ATBackRef

and rerun bin/buildout.

Change history

Changelog

unreleased (20zz-xx-yy) [tkimnguyen]
  • TODO: autocomplete for adding attendees
  • TODO: automatically link preceding and upcoming Meeting objects via Related Items field
  • TODO: for Solgema.fullcalendar, prevent "Add Meeting" from showing up when clicking on the Events calendar / or allow listing and adding Meeting objects in Events folder (probably easier)
  • TODO: implement one-time email notification as an action
  • TODO: (re) expose the "add comment" text field and button in meeting_view.pt that are normally there for non-Folderish content types
  • TODO: use BackReferenceBrowserWidget instead of BackReferenceWidget once it's not buggy!
  • TODO: Put up message indicating who received the email, if anyone did, or why email did not go out
  • TODO: complete i18n
0.6.3 (2013-03-03) [tkimnguyen]
  • "email all" attendees mailto: link handled differently if not logged in
0.6.2 (2012-12-06) [tkimnguyen]
  • Strip out whitespace from attendee values and correct bug in handling comma separated attendee values
0.6.1 (2012-12-06) [tkimnguyen]
  • Moved default values to a separate file, to be imported as needed.
0.6 (2012-12-06) [tkimnguyen]
  • When sending an email notification, handle cases when the meeting owner has no name or email address (default to site name and email address)
  • Move default email message subject and body out of the event handler
  • Can specify the subject and body of the email notification message in the ZMI Properties tab (uses acquisition): uwosh.meeting.defaultEmailSubject (should include two %s placeholders for string interpolation) and uwosh.meeting.defaultEmailBody (should include many %s placeholders; see code in meeting.py).
  • Cleans up attendees values: strips out @uwosh.edu in case someone pasted in email addresses, and separates comma separated values into multiple lines. Can override the string to strip out by setting a site property uwosh.meeting.defaultDomain, otherwise uses '@uwosh.edu'
  • Includes a link under the attendees list that lets user compose an email to all attendees
  • Added link to attach an image (the current "add attachment" link creates a File object). Renamed "add attachment" to "attach file".
  • Will send email notification to non-member attendees if they are listed using their email address. If non-member attendees are listed using just their username (does not contain '@') then the value of the defaultDomain is appended to their username to generate an email address which is used to send the email notification.
0.5 (2011-11-24) [tkimnguyen]
  • added tests
  • fixed problem with removal of attendee that had only Editor role
  • Owner role now gets "uwosh.meeting: Add Meeting" permission by default
0.4.3 (2011-11-23) [tkimnguyen]
  • automatically installs Products.ATBackRef
0.4.2 (2011-11-18) [tkimnguyen]
  • notification email message includes attendees email address; wording change from "has invited you to" to "has shared the following meeting"
0.4.1 (2011-11-18) [tkimnguyen]
  • fix bug when removing an attendee that had Editor role
  • improved handling of members without email addresses or full names
  • notification email message includes next and previous meeting URLs and lists attendees' full name as well as ID
0.4 (2011-09-30) [tkimnguyen]
  • update product description
  • add "add attachment" link to the meeting_view.pt
  • add "view" link to calendar view
  • move the "allow discussion" setting to the default schemata
  • added instructions on how to get published Meeting objects to show up on the calendar portlet
  • added previousMeeting and nextMeeting attributes that use ATBackRef to show bidirectional relations between Meeting objects; requires separate installation of Products.ATBackRef
0.3.1 (2011-09-13) [tkimnguyen]
  • version bump
0.3 (2011-09-12) [tkimnguyen]
  • add Action Items and Next Meeting Date Time attributes
  • prevent unicode errors on sending email notification
  • email notification message includes text/plain version of rich text field values
  • fixed incorrect default skin choice on install
0.2.2 (2011-08-29) [tkimnguyen]
  • add uwosh.meeting layer to all skins
  • add uninstall profile
0.2.1 (2011-08-28) [tkimnguyen]
  • restore missing Related Items
  • update content type description
  • in Solgema.fullcalendar view, added Edit and "Add attachment" links if user has Modify portal content permission
0.2 (2011-08-27) [tkimnguyen]
  • Can send invitation email to all attendees ('None', 'One-time only', 'On every edit')
  • Checkbox to allow attendees to edit the Meeting object
  • meeting_view and email notification includes listing of contained objects
0.1 (2011-08-24) [tkimnguyen]
  • Basic functionality and attributes

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.

>>> 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

Because add-on themes or products may remove or hide the login portlet, this test will use the login form that comes with plone.

>>> browser.open(portal_url + '/login_form')
>>> 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 ensure that we get the friendly logged-in message:

>>> "You are now logged in" in browser.contents
True

Finally, let's return to the front page of our site before continuing

>>> browser.open(portal_url)

-- extra stuff goes here -- The Meeting content type ===============================

In this section we are tesing the Meeting content type by performing basic operations like adding, updadating and deleting Meeting content items.

Adding a new Meeting content item

System Message: WARNING/2 (<string>, line 280)

Title underline too short.

Adding a new Meeting content item
--------------------------------

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 'Meeting' and click the 'Add' button to get to the add form.

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

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'Meeting Sample'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

And we are done! We added a new 'Meeting' content item to the portal.

Updating an existing Meeting content item

System Message: WARNING/2 (<string>, line 304)

Title underline too short.

Updating an existing Meeting content item
---------------------------------------

Let's click on the 'edit' tab and update the object attribute values.

>>> browser.getLink('Edit').click()
>>> browser.getControl(name='title').value = 'New Meeting Sample'
>>> browser.getControl('Save').click()

We check that the changes were applied.

>>> 'Changes saved' in browser.contents
True
>>> 'New Meeting Sample' in browser.contents
True
Removing a/an Meeting content item

System Message: WARNING/2 (<string>, line 320)

Title underline too short.

Removing a/an Meeting content item
--------------------------------

If we go to the home page, we can see a tab with the 'New Meeting Sample' title in the global navigation tabs.

>>> browser.open(portal_url)
>>> 'New Meeting Sample' in browser.contents
True

Now we are going to delete the 'New Meeting Sample' object. First we go to the contents tab and select the 'New Meeting Sample' for deletion.

>>> browser.getLink('Contents').click()
>>> browser.getControl('New Meeting Sample').click()

We click on the 'Delete' button.

>>> browser.getControl('Delete').click()
>>> 'Item(s) deleted' in browser.contents
True

So, if we go back to the home page, there is no longer a 'New Meeting Sample' tab.

>>> browser.open(portal_url)
>>> 'New Meeting Sample' in browser.contents
False
Adding a new Meeting content item as contributor

Not only site managers are allowed to add Meeting content items, but also site contributors.

Let's logout and then login as 'contributor', a portal member that has the contributor role assigned.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url + '/login_form')
>>> browser.getControl(name='__ac_name').value = 'contributor'
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()
>>> browser.open(portal_url)

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

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

We select 'Meeting' and click the 'Add' button to get to the add form.

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

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'Meeting Sample'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

Done! We added a new Meeting content item logged in as contributor.

Finally, let's login back as manager.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url + '/login_form')
>>> browser.getControl(name='__ac_name').value = portal_owner
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()
>>> browser.open(portal_url)

Contributors

  1. Kim Nguyen <nguyen@uwosh.edu>

Download