Capistrano Campfire notifier

http://svn.extendviget.com/lab/trunk/gems/capistrano_campfire_notifier

This gem notifies Campfire rooms after successful Capistrano deployments.

This gem was extracted from the VlCapistrano gem to allow easy use without the other, somewhat more esoteric features of VL Capistrano.

Requirements

This gem is only compatible with Capistrano 2.0.0 and higher. It is not now, and will never be, compatible with Capistrano 1.4.1 or earlier. If you are using one of the Capistrano 1.99.x "preview" releases, please upgrade to the current 2.x version.

This gem depends on Tinder, the unofficial Campfire API, which can be installed as usual: gem install tinder -y

This gem is tested primarily on Mac OS X and Linux. It may work on Windows, but is not tested or supported.

Installation and Configuration

To create the gem, run rake package in this directory, which will dump the gem in the pkg subdirectory. You can then install it with the gem command.

You'll then need to include the code in your Capistrano configuration (Capfile or deploy.rb:)

require 'capistrano/vl/campfire_notifier'

The Campfire room(s) to notify are specified in the configuration as a hash of hashes in the :campfires variable, such as the following:

set :campfires, { 'Viget' => {:domain => 'vl', :room => 'Roomname', :email => 'me@example.com', :password => 'password'},
                  'Client' => {:domain => 'client', :room => 'Roomname', :email => 'you@example.com', :password => 'drowssap'} }

By default, even if you set the :campfires hash, no rooms will be notified unless they are listed in the :campfire_notify array:

set :campfire_notify, ['Viget','Client']

We recommended you set :campfires in your $HOME/.caprc file instead of in a Capfile. This lets you check your Capfile into version control without exposing sensitive login credentials. The :campfire_notify variable lets you keep all of your Campfire info for all of your projects in one file, while only selecting the Campfires appropriate for a given project.