capfire 0.1.1 → 0.2.0

data/README.rdoc

@@ -7,10 +7,30 @@ This gem adds a way to send a message to campfire after a deploy, in the message
 == Install
 `gem install capfire`
 
-`script/generate capfire -k "campfire_token" -r "chat_room" -a "campfire_account"`                  
-This will generate a ~/.campfire file containing these settings. Feel free to edit it by hand, or run the generator with bogus data, it's a simple yaml file.
+Now either the generator:
+`script/generate capfire -k "campfire_token" -r "chat_room" -a "campfire_account"`
+This will create a ~/.campfire file and add a line to your config/deploy.rb file. 
 
-If the user doesn't have a ~/.campfire file it won't try to send a message to Campfire.
+Or do it by hand:
+In your config/deploy.rb append `require capfire/capistrano`, in your home folder create .campfire with the following contents
+
+campfire:
+  account: your_campfire_account
+  token: your_campfire_token
+  room: the_campfire_chatroom_to_post in
+  message: "I (#deployer#) deployed #application#
+with `cap #args# (#compare_url#)"
+
+From now on your deploys will send a message to Campfire containing the Github-compare view url.
+
+== Multiple Projects
+
+Either run the generator (without options since you've arleady got a ~/.campfire file it won't complain) again or append by hand the `require capfire/capistrano` line to your deploy file. 
+
+== Usage
+After the install you're done. Really, do a `cap deploy` and it should post to campfire.
+
+If anoyone on the project doesn't have Capfire installed he won't notice a difference, no message will be sent.
 
 == Note on Patches/Pull Requests
 

data/Rakefile

@@ -5,13 +5,13 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "capfire"
-    gem.summary = %Q{Send a notification to Campfire after a deploy}
+    gem.summary = %Q{Send a notification to Campfire after a cap deploy}
     gem.description = %Q{Inspired by http://github.com/blog/609-tracking-deploys-with-compare-view}
     gem.email = "junkiesxl@gmail.com"
     gem.homepage = "http://github.com/pjaspers/Capfire"
     gem.authors = ["pjaspers"]
-    gem.files = FileList['[A-Z]*', 
-      'generators/**/*.*', 
+    gem.files = FileList['[A-Z]*',
+      'generators/**/*.*',
       'lib/**/*.rb',
       'lib/templates/*.erb']
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/generators/capfire_generator.rb

@@ -25,6 +25,8 @@ campfire:
   account: #{options[:campfire_account]}
   token: #{options[:campfire_token]}
   room: #{options[:chat_room]}
+  message: "I (#deployer#) deployed #application#
+with `cap #args#` (#compare_url#)"
 CONF
       unless campfire_file_exists?
         File.open(File.join(ENV['HOME'],'.campfire'), 'w') do |out|

data/generators/templates/capistrano_hook.rb

@@ -1,5 +1,6 @@
-Dir[File.join(File.dirname(__FILE__), '..', 'vendor', 'gems', 'capfire-*')].each do |vendored_notifier|
-  $: << File.join(vendored_notifier, 'lib')
+begin
+  require 'capfire/capistrano'
+rescue Object
+  # Don't force other users to install Capfire.
 end
 
-require 'capfire/capistrano'

data/lib/capfire.rb

@@ -1,7 +1,6 @@
-
-
-# Gem for applications to automatically post errors to the Hoptoad of their choice.
+# Gem for applications to automatically post to Campfire after an deploy.
 module Capfire
-
+  # Nothing to see here, take a gander at the generator
+  # or in the capistrano.rb
 end
 

data/lib/capfire/capistrano.rb

@@ -1,8 +1,11 @@
-# Defines deploy:notify_hoptoad which will send information about the deploy to Hoptoad.
+# Defines deploy:notify_campfire
+
+require 'broach'
 
 Capistrano::Configuration.instance(:must_exist).load do
 
-  if File.exists?(File.join(ENV['HOME'],'.campfire'))          
+  # Don't bother users who have capfire installed but don't have a ~/.campfire file
+  if File.exists?(File.join(ENV['HOME'],'.campfire'))
     after "deploy:update_code", "deploy:notify_campfire"
   end
 
@@ -21,12 +24,16 @@ Capistrano::Configuration.instance(:must_exist).load do
       # Getting the github url
       github_url = repository.gsub(/git@/, 'http://').gsub(/\.com:/,'.com/').gsub(/\.git/, '')
       compare_url = "#{github_url}/compare/#{deployed}...#{deploying}"
+
+      # Reading the config file.
       config = YAML::load(File.open(File.join(ENV['HOME'],'.campfire')))
+
+      # Ugly but it does the job.
+      message = config["campfire"]["message"].gsub(/#deployer#/, deployer).gsub(/#application#/, application).gsub(/#args#/, ARGV.join(' ')).gsub(/#compare_url#/,compare_url)
+
+      # Posting the message.
       Broach.settings = { 'account' => config["campfire"]["account"], 'token' => config["campfire"]["token"] }
-      Broach.speak(campfire_room,
-                   "I (#{deployer}) deployed #{application} " +
-                   "with `cap #{ARGV.join(' ')}` (#{compare_url})"
-                   )
+      Broach.speak(config["campfire"]["room"], message)
     end
   end
 end

data/test/test_Capfire.rb

@@ -1,5 +1,6 @@
 require 'helper'
 
+# Don't really have an idea how to test this.
 class TestCapfire < Test::Unit::TestCase
   should "probably rename this file and start testing for real" do
     flunk "hey buddy, you should probably rename this file and start testing for real"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - pjaspers
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-25 00:00:00 +01:00
+date: 2010-03-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,7 +91,7 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Send a notification to Campfire after a deploy
+summary: Send a notification to Campfire after a cap deploy
 test_files: 
 - test/helper.rb
 - test/test_Capfire.rb