README

= pivotal-tracker-email-integration
 
* http://github.com/mcommons/pivotal-tracker-email-integration
 

== DESCRIPTION:

A Ruby script that can be called from procmail that will automatically create Tracker stories


== INSTALLATION:

First you need an email address to forward things to.  tracker@your-domain.com will probably work well.
In the tracker's home directory, create a .procmailrc file that simply pipes all incoming mail to the tracker.rb script.

Mine looks like this:

:0
*
#* ^To:*
|ruby /home/tracker/tracker_email.rb

To create a story, just send an email to that address.  The subject will become the story title and the body will be the description.

"Plus addressing" is supported to define the story type.  So sending an email to tracker+bug@your-domain.com will create a Bug, while tracker+feature@your-domain.com will create a Feature (default).

The script relies on a Ruby library to interact with Tracker's API.  It's packaged in here for convenience.  

You need to pass your tracker project number and an API key to the client library.  You must define them at the top of the tracker.rb procmail script.


=== CHANGELOG:

2008-12-14:
 - Added support for long emails by splitting the body into a description and comments (Tracker has a 5K character limit on each)

2008-12-14:
 - Initial release

=== Contributers

Benjamin Stein, http://github.com/benstein


== LICENSE:

(The MIT License)

Copyright (c) 2008 Mobile Commons

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.