cap_gun 0.0.9 → 0.2.0

data/.autotest

@@ -0,0 +1,12 @@
+require 'autotest/menu'
+
+Autotest.add_hook :initialize do |at|
+  at.clear_mappings
+  
+  at.add_mapping(%r%lib/(.*)\.rb$%) { |filename, match|
+    at.files_matching %r%^spec/#{match[1]}.*\.rb$%
+  }
+  at.add_mapping(%r%^spec/.*\.rb$%) { |filename, match|
+    filename
+  }
+end

data/.gitignore

@@ -0,0 +1,3 @@
+doc
+pkg
+coverage

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Relevance, Inc.
+Copyright (c) 2009 Relevance, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.rdoc → README.markdown}

@@ -1,6 +1,6 @@
-= CapGun
+# CapGun
   
-== DESCRIPTION
+## DESCRIPTION
 
 Tell everyone about your releases!  Send email notification after Capistrano deployments!  Rule the world!
 
@@ -10,7 +10,7 @@ Setup and configuration are done entirely inside your deploy.rb file to keep it
 
 This even includes the Net::SMTP TLS hack inside as a vendored dependancy to allow super easy email sending without setting up an MTA.
 
-== CONFIG
+## CONFIG
 
 In your Capistrano config file (usually deploy.rb):
 
@@ -27,51 +27,55 @@ In your Capistrano config file (usually deploy.rb):
     }
 
     # define the options for the actual emails that go out -- :recipients is the only required option
-    set :cap_gun_email_envelope, { :recipients => %w[joe@example.com, jane@example.com] }
+    set :cap_gun_email_envelope, { 
+      :from => "project.deployer@example.com", # Note, don't use the form "Someone project.deploy@example.com" as it'll blow up with ActionMailer 2.3+
+      :recipients => %w[joe@example.com, jane@example.com] 
+    }
     
     # register email as a callback after restart
     after "deploy:restart", "cap_gun:email"
     
     # Test everything out by running "cap cap_gun:email"
 
-== USAGE
+## USAGE
 
 Good news: it just works.  
 
+By default CapGun includes info like the user who is deploying and what server its being deployed to.  CapGun is biased for git (patches accepted for other SCMs), so it will include details like your current branch, the revisions since last deployment, the current commit being deployed.
+
 Want to make the notifications even better and explain _why_ you're deploying?
 Just include a comment in the cap command like so, and CapGun will add the comment to the email notification.
 
     cap -s comment="fix for bug #303" deploy
 
-== REQUIREMENTS
+## REQUIREMENTS
 
 * Capistrano 2+
 * A Gmail account to send from, or an MTA (mail transport agent) installed locally to send from
 * Something to deploy
 
-== TODO & KNOWN ISSUES
+## TODO & KNOWN ISSUES
 
 * displays the release times in UTC (Capistrano default) - could be flipped to specified time zone
-* some stuff will probably break on windows
+* some stuff will probably break on windows - patches welcome
 
-== INSTALL
+## INSTALL
 
-* sudo gem install cap_gun  and gem unpack into your vendor/plugins
+* `sudo gem install cap_gun`  and gem unpack into your vendor/plugins
 * or just grab the tarball from github (see below)
 
+## URLS
 
-== URLS
-
-* Log bugs, issues, and suggestions on Trac: http://opensource.thinkrelevance.com/wiki/cap_gun
-* View source: http://github.com/relevance/cap_gun/tree/master
-* Git: git clone git://github.com/relevance/cap_gun.git
-* RDocs: http://thinkrelevance.rubyforge.org/cap_gun/
+* Log bugs, issues, and suggestions at GitHub: http://github.com/relevance/cap_gun/issues
+* View source: http://github.com/relevance/cap_gun
+* Continuos Integration: http://runcoderun.com/relevance/cap_gun
+* RDocs: http://thinkrelevance.rubyforge.org/cap_gun
 
 == LICENSE
 
 (The MIT License)
 
-Copyright (c) 2008 Relevance, Inc. - http://thinkrelevance.com
+Copyright (c) 2009 Relevance, Inc. - http://thinkrelevance.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,19 +1,36 @@
-require 'rubygems'
-gem 'echoe', '~> 3.0.1'
-require 'echoe'
-require './lib/cap_gun.rb'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "cap_gun"
+    gemspec.summary = "Bang! You're deployed."
+    gemspec.email = "opensource@thinkrelevance.com"
+    gemspec.homepage = "http://github.com/relevance/cap_gun"
+    gemspec.description = 'Super simple capistrano deployment notifications.'
+    gemspec.authors = ["Rob Sanheim", "Muness Alrubaie", "Relevance"]
+    gemspec.add_development_dependency "micronaut"
+    gemspec.add_development_dependency "mocha"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
 
-echoe = Echoe.new('cap_gun') do |p|
-  p.rubyforge_name = 'thinkrelevance'
-  p.author = ["Rob Sanheim", "Relevance"]
-  p.email = 'opensource@thinkrelevance.com'
-  p.version = CapGun::VERSION
-  p.summary = "Bang! You're deployed!"
-  p.description = 'Super simple capistrano deployments.'
-  p.url = "http://opensource.thinkrelevance.com/wiki/cap_gun"
-  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc|CHANGELOG|MIT-LICENSE$/
-  rdoc_template = `allison --path`.strip << ".rb"
-  p.rdoc_template = rdoc_template
-  p.test_pattern = 'spec/**/*_spec.rb'
-  p.manifest_name = 'manifest.txt'
-end
+begin 
+  require 'micronaut/rake_task'
+  Micronaut::RakeTask.new(:examples) do |examples|
+    examples.pattern = 'examples/**/*_example.rb'
+    examples.ruby_opts << '-Ilib -Iexamples'
+  end
+
+  Micronaut::RakeTask.new(:rcov) do |examples|
+    examples.pattern = 'examples/**/*_example.rb'
+    examples.rcov_opts = %[-Ilib -Iexamples --exclude "gems/*,/Library/Ruby/*,config/*" --text-summary  --sort coverage]
+    examples.rcov = true
+  end
+end
+
+if RUBY_VERSION =~ /1.8/ 
+  task :default => [:check_dependencies, :rcov]
+else
+  task :default => [:check_dependencies, :examples]
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/cap_gun.gemspec

@@ -1,87 +1,67 @@
+# -*- encoding: utf-8 -*-
 
-# Gem::Specification for Cap_gun-0.0.9
-# Originally generated by Echoe
+Gem::Specification.new do |s|
+  s.name = %q{cap_gun}
+  s.version = "0.2.0"
 
---- !ruby/object:Gem::Specification 
-name: cap_gun
-version: !ruby/object:Gem::Version 
-  version: 0.0.9
-platform: ruby
-authors: 
-- Rob Sanheim, Relevance
-autorequire: 
-bindir: bin
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob Sanheim", "Muness Alrubaie", "Relevance"]
+  s.date = %q{2009-06-21}
+  s.description = %q{Super simple capistrano deployment notifications.}
+  s.email = %q{opensource@thinkrelevance.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".autotest",
+     ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "cap_gun.gemspec",
+     "examples/cap_gun_example.rb",
+     "examples/example_helper.rb",
+     "examples/presenter_example.rb",
+     "init.rb",
+     "install.rb",
+     "lib/cap_gun.rb",
+     "lib/cap_gun/presenter.rb",
+     "manifest.txt",
+     "tasks/cap_bot_tasks.rake",
+     "vendor/action_mailer_tls/README",
+     "vendor/action_mailer_tls/init.rb",
+     "vendor/action_mailer_tls/lib/smtp_tls.rb",
+     "vendor/action_mailer_tls/sample/mailer.yml.sample",
+     "vendor/action_mailer_tls/sample/smtp_gmail.rb",
+     "version.yml"
+  ]
+  s.homepage = %q{http://github.com/relevance/cap_gun}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{thinkrelevance}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Bang! You're deployed.}
+  s.test_files = [
+    "examples/cap_gun_example.rb",
+     "examples/example_helper.rb",
+     "examples/presenter_example.rb"
+  ]
 
-date: 2008-10-30 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: Super simple capistrano deployments.
-email: opensource@thinkrelevance.com
-executables: []
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
 
-extensions: []
-
-extra_rdoc_files: 
-- CHANGELOG
-- lib/cap_gun.rb
-- MIT-LICENSE
-- README.rdoc
-files: 
-- cap_gun.gemspec
-- CHANGELOG
-- init.rb
-- install.rb
-- lib/cap_gun.rb
-- manifest.txt
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
-- spec/cap_gun_spec.rb
-- tasks/cap_bot_tasks.rake
-- vendor/action_mailer_tls/init.rb
-- vendor/action_mailer_tls/lib/smtp_tls.rb
-- vendor/action_mailer_tls/README
-- vendor/action_mailer_tls/sample/mailer.yml.sample
-- vendor/action_mailer_tls/sample/smtp_gmail.rb
-has_rdoc: true
-homepage: http://opensource.thinkrelevance.com/wiki/cap_gun
-post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Cap_gun
-- --main
-- README.rdoc
-require_paths: 
-- lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "1.2"
-  version: 
-requirements: []
-
-rubyforge_project: thinkrelevance
-rubygems_version: 1.3.0
-specification_version: 2
-summary: Bang! You're deployed!
-test_files: 
-- spec/cap_gun_spec.rb
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<spicycode-micronaut>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<spicycode-micronaut>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<spicycode-micronaut>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end

data/examples/cap_gun_example.rb

@@ -0,0 +1,66 @@
+require File.join(File.dirname(__FILE__), *%w[example_helper])
+
+describe CapGun do
+
+  it "uses action mailer hack" do
+    Net::SMTP.new('').respond_to?(:starttls, true).should == true
+  end
+
+  describe "mail settings" do
+    
+    it "raises if we don't have settings" do
+      capistrano = stub_everything
+      lambda { 
+        CapGun::Mailer.load_mailer_config(capistrano) 
+      }.should raise_error(ArgumentError, "You must define ActionMailer settings in 'cap_gun_action_mailer_config'")
+    end
+  
+    it "gets action mailer config from capistrano" do
+      capistrano = stub(:cap_gun_action_mailer_config => {:account => "foo@gmail.com", :password => "password"}, :exists? => true)
+      capistrano.stubs(:[]).returns({:recipients => 'foo'})
+      CapGun::Mailer.load_mailer_config(capistrano)
+      ActionMailer::Base.smtp_settings.should == {:account => "foo@gmail.com", :password => "password"}
+    end
+    
+    it "raises if don't have a cap gun email envelope" do
+      capistrano = stub_everything(:cap_gun_action_mailer_config => {}, :exists? => false)
+      lambda { 
+        CapGun::Mailer.load_mailer_config capistrano 
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "raises if we don't have at least one recipient" do
+      capistrano = stub_everything(:cap_gun_action_mailer_config => {}, :cap_gun_email_envelope => {})
+      lambda { 
+        CapGun::Mailer.load_mailer_config capistrano 
+      }.should raise_error(ArgumentError)
+      capistrano = stub_everything(:cap_gun_action_mailer_config => {}, :cap_gun_email_envelope => {:recipients => []})
+      lambda { 
+        CapGun::Mailer.load_mailer_config capistrano 
+      }.should raise_error(ArgumentError)
+    end
+    
+  end
+  
+  describe CapGun::Mailer do
+    
+    it "calls Net::SMTP to send the mail correctly (we test this because SMTP internals changed between 1.8.6 and newer versions of Ruby)" do
+      ActionMailer::Base.smtp_settings = {
+        :address => "smtp.gmail.com",
+        :port => 587,
+        :domain => "foo.com",
+        :authentication => :plain,
+        :user_name => "username",
+        :password => "password"
+      }
+    
+      capistrano = { :current_release => "/data/foo", :previous_release => "/data/foo", :cap_gun_email_envelope => {:recipients => ["joe@example.com"]} }        
+      smtp = Net::SMTP.new('gmail.com', 25)
+      Net::SMTP.expects(:new).returns(smtp)
+      smtp.expects(:start)
+      CapGun::Mailer.deliver_deployment_notification capistrano
+    end
+    
+  end
+  
+end

data/examples/example_helper.rb

@@ -0,0 +1,19 @@
+ENV["RAILS_ENV"] = "test"
+require 'net/smtp'
+require "mocha"
+require 'micronaut'
+require File.join(File.dirname(__FILE__), *%w[.. lib cap_gun])
+
+def silence_warnings
+  old_verbose, $VERBOSE = $VERBOSE, nil
+  yield
+ensure
+  $VERBOSE = old_verbose
+end
+
+Micronaut.configure do |config|
+  config.mock_with :mocha
+  config.formatter = :documentation
+  config.color_enabled = true
+  config.filter_run :options => { :focused => true }
+end

data/examples/presenter_example.rb

@@ -0,0 +1,86 @@
+require File.join(File.dirname(__FILE__), *%w[example_helper])
+
+describe CapGun::Presenter do 
+
+  describe "git details" do
+  
+    it "does nothing if git is not the scm" do
+      presenter = CapGun::Presenter.new(stub("capistrano", :scm => :svn))
+      presenter.git_details.should == nil
+    end
+  
+    it "collects branch and git log details if git is scm" do
+      capistrano = {:scm => :git, :branch => "edge"}
+      presenter = CapGun::Presenter.new(capistrano)
+      presenter.expects(:git_log).returns("xxxxx")
+    
+      details = presenter.git_details
+      details.should include("Branch: edge")
+      details.should include("xxxxx")
+    end
+  end
+
+  describe "git log messages" do
+
+    it "returns N/A if the git log call returns an error" do
+      capistrano = { :previous_revision => "previous-sha", :current_revision => "current-sha" }
+      presenter = CapGun::Presenter.new(capistrano)
+      presenter.stubs(:`).returns("fatal: Not a git repo")
+      presenter.stubs(:exit_code).returns(stub("process status", :success? => false))
+      presenter.git_log_messages.should == "N/A"
+    end
+  
+    it "calls git log with previous_rev..current_rev" do
+      capistrano = { :previous_revision => "previous-sha", :current_revision => "current-sha" }
+      presenter = CapGun::Presenter.new(capistrano)
+      presenter.stubs(:exit_code).returns(stub("process status", :success? => true))
+      presenter.expects(:`).with(includes("git log previous-sha..current-sha"))
+      presenter.git_log_messages
+    end
+  end
+
+  describe "release time" do
+  
+    before do # make DateTime act as if local timezone is CDT
+      @presenter = CapGun::Presenter.new(nil)
+      @presenter.stubs(:local_timezone).returns("CDT")
+      @presenter.stubs(:local_datetime_zone_offset).returns(Rational(-1,6))
+    end
+  
+    it "returns nil for weird release path" do
+      @presenter.humanize_release_time("/data/foo/my_release").should == nil
+    end
+  
+    it "parse datetime from release path" do
+      @presenter.humanize_release_time("/data/foo/releases/20080227120000").should == "February 27th, 2008 8:00 AM CDT"
+    end
+  
+    it "converts time from release into localtime" do
+      @presenter.humanize_release_time("/data/foo/releases/20080410040000").should == "April 10th, 2008 12:00 AM CDT"
+    end
+  
+  end
+
+  describe "from and to emails" do
+    
+    it "gets recipients from email envelope" do
+      capistrano = { :cap_gun_email_envelope => { :recipients => ["foo@here.com", "bar@here.com"] } }
+      presenter = CapGun::Presenter.new(capistrano)
+      presenter.recipients.should == ["foo@here.com", "bar@here.com"]
+    end
+
+    it "should have a default sender" do
+      capistrano = { :cap_gun_email_envelope => { } }
+      presenter = CapGun::Presenter.new(capistrano)
+      presenter.from.should == "\"CapGun\" <cap_gun@example.com>"
+    end
+  
+    it "should override sender from email envelope" do
+      capistrano = { :cap_gun_email_envelope => { :from => "booyakka!@example.com" } }
+      presenter = CapGun::Presenter.new(capistrano)
+      presenter.from.should == "booyakka!@example.com"
+    end
+    
+  end
+
+end

data/lib/cap_gun.rb

@@ -1,4 +1,6 @@
 require 'action_mailer'
+
+require File.join(File.dirname(__FILE__), *%w[cap_gun presenter])
 require File.join(File.dirname(__FILE__), *%w[.. vendor action_mailer_tls lib smtp_tls])
 
 # Tell everyone about your releases!  Send email notification after Capistrano deployments!  Rule the world!
@@ -26,121 +28,35 @@ require File.join(File.dirname(__FILE__), *%w[.. vendor action_mailer_tls lib sm
 #
 # See README for full install/config instructions.
 module CapGun
-  VERSION = '0.0.9'
+  VERSION = '0.0.11'
 
-  module Helper
-    
-    # Loads ActionMailer settings from a Capistrano variable called "cap_gun_action_mailer_config"
-    def load_mailer_config(cap) 
-      raise ArgumentError, "You must define ActionMailer settings in 'cap_gun_action_mailer_config'" unless cap.cap_gun_action_mailer_config 
-      raise ArgumentError, "Need at least one recipient." if !cap.exists?(:cap_gun_email_envelope) || cap[:cap_gun_email_envelope][:recipients].blank?
-      
-      ActionMailer::Base.smtp_settings = cap.cap_gun_action_mailer_config
-    end
-  
-    # Current user - unsupported on Windows, patches welcome
-    def current_user
-      platform.include?('mswin') ? nil : `id -un`.strip
-    end
-    
-    # stub hook purposes only
-    def platform
-      RUBY_PLATFORM
-    end
-  
-    # Gives you a prettier date/time for output from the standard Capistrano timestamped release directory.
-    # This assumes Capistrano uses UTC for its date/timestamped directories, and converts to the local
-    # machine timezone.
-    def humanize_release_time(path)
-      return unless path
-      match = path.match(/(\d+)$/)
-      return unless match
-      local = convert_from_utc(match[1])
-      local.strftime("%B #{local.day.ordinalize}, %Y %l:%M %p #{local_timezone}").gsub(/\s+/, ' ').strip
-    end
-    
-    # Use some DateTime magicrey to convert UTC to the current time zone
-    # When the whole world is on Rails 2.1 (and therefore new ActiveSupport) we can use the magic timezone support there.
-    def convert_from_utc(timestamp)
-      # we know Capistrano release timestamps are UTC, but Ruby doesn't, so make it explicit
-      utc_time = timestamp << "UTC" 
-      datetime = DateTime.parse(utc_time)
-      datetime.new_offset(local_datetime_zone_offset)
-    end
-    
-    def local_datetime_zone_offset
-      @local_datetime_zone_offset ||= DateTime.now.offset
-    end
-    
-    def local_timezone
-      @current_timezone ||= Time.now.zone
-    end
-    
-    extend self
-  end
-  
   # This mailer is configured with a capistrano variable called "cap_gun_email_envelope"
   class Mailer < ActionMailer::Base
-      include CapGun::Helper
-      DEFAULT_SENDER = %("CapGun" <cap_gun@example.com>)
-      DEFAULT_EMAIL_PREFIX = "[DEPLOY]"
-      
-      adv_attr_accessor :email_prefix
-      attr_accessor :summary
+
+      def self.load_mailer_config(cap)
+       raise ArgumentError, "You must define ActionMailer settings in 'cap_gun_action_mailer_config'" unless cap.cap_gun_action_mailer_config
+       raise ArgumentError, "Need at least one recipient." if !cap.exists?(:cap_gun_email_envelope) || cap[:cap_gun_email_envelope][:recipients].blank?
+
+       ActionMailer::Base.smtp_settings = cap.cap_gun_action_mailer_config
+      end
       
-      # Grab the options for emailing from cap_gun_email_envelope (should be set in your deploy file)
+      # Grab the options for emailing from capistrano[:cap_gun_email_envelope] (should be set in your deploy file)
       #
       # Valid options:
       #     :recipients     (required) an array or string of email address(es) that should get notifications
       #     :from           the sender of the notification, defaults to cap_gun@example.com
       #     :email_prefix   subject prefix, defaults to [DEPLOY]
-      def init(envelope = {})
-        recipients envelope[:recipients]
-        from (envelope[:from] || DEFAULT_SENDER)
-        email_prefix (envelope[:email_prefix] || DEFAULT_EMAIL_PREFIX)
-      end
-      
-      # Do the actual email
       def deployment_notification(capistrano)
-        init(capistrano[:cap_gun_email_envelope])
-        self.summary = create_summary(capistrano)
+        presenter = Presenter.new(capistrano)
         
         content_type "text/plain"
-        subject "#{email_prefix} #{capistrano[:application]} #{deployed_to(capistrano)}"
-        body    create_body(capistrano)
-      end
-      
-      def create_summary(capistrano)
-        %[#{capistrano[:application]} was deployed#{" to " << capistrano[:rails_env] if capistrano[:rails_env]} by #{current_user} at #{humanize_release_time(capistrano[:current_release])}.]
-      end
-      
-      def deployed_to(capistrano)
-        returning(deploy_msg = "deployed") { |msg| msg << " to #{capistrano[:rails_env]}" if capistrano[:rails_env] }
-      end
-      
-      # Create the body of the message using a bunch of values from Capistrano
-      def create_body(capistrano)
-<<-EOL
-#{summary}
-
-Comment: #{capistrano[:comment] || "[none given]"}
-
-Nerd details
-============
-Release: #{capistrano[:current_release]}
-Release Time: #{humanize_release_time(capistrano[:current_release])}
-Release Revision: #{capistrano[:current_revision]}
-
-Previous Release: #{capistrano[:previous_release]}
-Previous Release Time: #{humanize_release_time(capistrano[:previous_release])}
-Previous Release Revision: #{capistrano[:previous_revision]}
-
-Repository: #{capistrano[:repository]}
-Deploy path: #{capistrano[:deploy_to]}
-EOL
+        from         presenter.from
+        recipients   presenter.recipients
+        subject      presenter.subject
+        body         presenter.body
       end
     end
-
+    
 end
 
 if Object.const_defined?("Capistrano")
@@ -149,8 +65,8 @@ if Object.const_defined?("Capistrano")
 
     namespace :cap_gun do
       desc "Send notification of the current release and the previous release via email."
-      task :email do
-        CapGun::Helper.load_mailer_config(self)
+      task :email, :roles => :app do
+        CapGun::Mailer.load_mailer_config(self)
         CapGun::Mailer.deliver_deployment_notification(self)
       end
     end

data/lib/cap_gun/presenter.rb

@@ -0,0 +1,133 @@
+require 'etc'
+
+module CapGun
+  class Presenter
+    DEFAULT_SENDER = %("CapGun" <cap_gun@example.com>)
+    DEFAULT_EMAIL_PREFIX = "[DEPLOY]"
+    
+    attr_accessor :capistrano
+    
+    def initialize(capistrano)
+      self.capistrano = capistrano
+    end
+    
+
+    def recipients
+      capistrano[:cap_gun_email_envelope][:recipients]
+    end
+
+    def email_prefix
+      capistrano[:cap_gun_email_envelope][:email_prefix] || DEFAULT_EMAIL_PREFIX
+    end
+
+    def from
+      capistrano[:cap_gun_email_envelope][:from] || DEFAULT_SENDER
+    end
+    
+    def current_user
+      Etc.getlogin
+    end
+
+    def summary
+      %[#{capistrano[:application]} was #{deployed_to} by #{current_user} at #{release_time}.]
+    end
+
+    def deployed_to
+      return "deployed to #{capistrano[:rails_env]}" if capistrano[:rails_env]
+      "deployed"
+    end
+
+    def branch
+      "Branch: #{capistrano[:branch]}" unless capistrano[:branch].nil? || capistrano[:branch].empty?
+    end
+
+    def git_details
+      return unless capistrano[:scm].to_sym == :git
+      <<-EOL
+#{branch}
+#{git_log}
+      EOL
+      rescue
+        nil
+    end
+
+    def git_log
+      "\nCommits since last release\n====================\n#{git_log_messages}"
+    end
+
+    def git_log_messages
+      messages = `git log #{capistrano[:previous_revision]}..#{capistrano[:current_revision]} --pretty=format:%h:%s`
+      exit_code.success? ? messages : "N/A"
+    end
+    
+    def exit_code
+      $?
+    end
+    
+    # Gives you a prettier date/time for output from the standard Capistrano timestamped release directory.
+    # This assumes Capistrano uses UTC for its date/timestamped directories, and converts to the local
+    # machine timezone.
+    def humanize_release_time(path)
+      return unless path
+      match = path.match(/(\d+)$/)
+      return unless match
+      local = convert_from_utc(match[1])
+      local.strftime("%B #{local.day.ordinalize}, %Y %l:%M %p #{local_timezone}").gsub(/\s+/, ' ').strip
+    end
+    
+    # Use some DateTime magicrey to convert UTC to the current time zone
+    # When the whole world is on Rails 2.1 (and therefore new ActiveSupport) we can use the magic timezone support there.
+    def convert_from_utc(timestamp)
+      # we know Capistrano release timestamps are UTC, but Ruby doesn't, so make it explicit
+      utc_time = timestamp << "UTC" 
+      datetime = DateTime.parse(utc_time)
+      datetime.new_offset(local_datetime_zone_offset)
+    end
+    
+    def local_datetime_zone_offset
+      @local_datetime_zone_offset ||= DateTime.now.offset
+    end
+    
+    def local_timezone
+      @current_timezone ||= Time.now.zone
+    end
+    
+    def release_time
+      humanize_release_time(capistrano[:current_release])
+    end
+    
+    def previous_release_time 
+      humanize_release_time(capistrano[:previous_release])
+    end
+
+    def subject
+      "#{email_prefix} #{capistrano[:application]} #{deployed_to}"
+    end
+    
+    def comment
+      "Comment: #{capistrano[:comment]}.\n" if capistrano[:comment]
+    end
+
+    def body
+<<-EOL
+#{summary}
+#{comment}
+Deployment details
+==================
+Release: #{capistrano[:current_release]}
+Release Time: #{release_time}
+Release Revision: #{capistrano[:current_revision]}
+
+Previous Release: #{capistrano[:previous_release]}
+Previous Release Time: #{previous_release_time}
+Previous Release Revision: #{capistrano[:previous_revision]}
+
+Repository: #{capistrano[:repository]}
+Deploy path: #{capistrano[:deploy_to]}
+Domain: #{capistrano[:domain]}
+#{git_details}
+EOL
+    end
+
+  end
+end

data/version.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 2

metadata

@@ -1,19 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: cap_gun
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
+  version: 0.2.0
 platform: ruby
 authors: 
-- Rob Sanheim, Relevance
+- Rob Sanheim
+- Muness Alrubaie
+- Relevance
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-10-30 00:00:00 -04:00
+date: 2009-06-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: echoe
+  name: spicycode-micronaut
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -22,44 +24,55 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: Super simple capistrano deployments.
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Super simple capistrano deployment notifications.
 email: opensource@thinkrelevance.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
+- README.markdown
+files: 
+- .autotest
+- .gitignore
 - CHANGELOG
-- lib/cap_gun.rb
 - MIT-LICENSE
-- README.rdoc
-files: 
+- README.markdown
+- Rakefile
+- VERSION
 - cap_gun.gemspec
-- CHANGELOG
+- examples/cap_gun_example.rb
+- examples/example_helper.rb
+- examples/presenter_example.rb
 - init.rb
 - install.rb
 - lib/cap_gun.rb
+- lib/cap_gun/presenter.rb
 - manifest.txt
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
-- spec/cap_gun_spec.rb
 - tasks/cap_bot_tasks.rake
+- vendor/action_mailer_tls/README
 - vendor/action_mailer_tls/init.rb
 - vendor/action_mailer_tls/lib/smtp_tls.rb
-- vendor/action_mailer_tls/README
 - vendor/action_mailer_tls/sample/mailer.yml.sample
 - vendor/action_mailer_tls/sample/smtp_gmail.rb
+- version.yml
 has_rdoc: true
-homepage: http://opensource.thinkrelevance.com/wiki/cap_gun
+homepage: http://github.com/relevance/cap_gun
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Cap_gun
-- --main
-- README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -72,14 +85,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
 rubyforge_project: thinkrelevance
-rubygems_version: 1.3.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
-summary: Bang! You're deployed!
+specification_version: 3
+summary: Bang! You're deployed.
 test_files: 
-- spec/cap_gun_spec.rb
+- examples/cap_gun_example.rb
+- examples/example_helper.rb
+- examples/presenter_example.rb

data/spec/cap_gun_spec.rb

@@ -1,154 +0,0 @@
-ENV["RAILS_ENV"] = "test"
-require 'rubygems'
-require 'test/unit'
-require 'test/spec'
-require 'mocha'
-require 'net/smtp'
-require 'redgreen' unless Object.const_defined?("TextMate")
-require File.join(File.dirname(__FILE__), *%w[.. lib cap_gun])
-
-describe "CapGun" do
-  it "uses action mailer hack" do
-    Net::SMTP.new('').respond_to?(:starttls, true).should == true
-  end
-end
-
-describe "CapGun" do
-
-  describe "mail settings" do
-    include CapGun::Helper
-    
-    it "raises if we don't have settings" do
-      capistrano = stub_everything
-      lambda { CapGun::Helper.load_mailer_config(capistrano) }.should.raise(ArgumentError).message.should == "You must define ActionMailer settings in 'cap_gun_action_mailer_config'"
-    end
-  
-    it "gets action mailer config from capistrano" do
-      capistrano = stub(:cap_gun_action_mailer_config => {:account => "foo@gmail.com", :password => "password"}, :exists? => true)
-      capistrano.stubs(:[]).returns({:recipients => 'foo'})
-      CapGun::Helper.load_mailer_config(capistrano)
-      ActionMailer::Base.smtp_settings.should == {:account => "foo@gmail.com", :password => "password"}
-    end
-    
-    it "raises if we have no cap gun email envelope" do
-      capistrano = stub_everything(:cap_gun_action_mailer_config => {}, :exists? => false)
-      lambda { CapGun::Helper.load_mailer_config capistrano }.should.raise(ArgumentError)
-    end
-    
-    it "raises if we don't have at least one recipient" do
-      capistrano = stub_everything(:cap_gun_action_mailer_config => {}, :cap_gun_email_envelope => {})
-      lambda { CapGun::Helper.load_mailer_config capistrano }.should.raise(ArgumentError)
-      capistrano = stub_everything(:cap_gun_action_mailer_config => {}, :cap_gun_email_envelope => {:recipients => []})
-      lambda { CapGun::Helper.load_mailer_config capistrano }.should.raise(ArgumentError)
-    end
-    
-  end
-  
-  describe "misc helpers" do
-    include CapGun::Helper
-    
-    it "returns nil for current user if platform is win32" do
-      expects(:platform).returns("mswin")
-      current_user.should.be nil
-    end
-    
-    it "should get current user from *nix id command" do
-      expects(:"`").with('id -un').returns("joe")
-      current_user
-    end
-    
-  end
-  
-  describe "handling release time" do
-      include CapGun::Helper
-    
-    before do # make DateTime act as if local timezone is EDT
-      stubs(:local_timezone).returns("EDT")
-      stubs(:local_datetime_zone_offset).returns(Rational(-1,6))
-    end
-    
-    it "returns nil for weird release path" do
-      humanize_release_time("/data/foo/my_release").should == nil
-    end
-    
-    it "parse datetime from release path" do
-      humanize_release_time("/data/foo/releases/20080227120000").should == "February 27th, 2008 8:00 AM EDT"
-    end
-    
-    it "converts time from release into localtime" do
-      humanize_release_time("/data/foo/releases/20080410040000").should == "April 10th, 2008 12:00 AM EDT"
-    end
-    
-  end
-  
-  describe "Mailer" do
-    
-    it "passes capistrano into create body" do
-      capistrano = { :current_release => "/data/foo", :previous_release => "/data/foo", :cap_gun_email_envelope => {:recipients => ["joe@example.com"]} }
-      CapGun::Mailer.any_instance.expects(:create_body).with(capistrano).returns("foo")
-      CapGun::Mailer.create_deployment_notification capistrano
-    end
-    
-    it "calls Net::SMTP to send the mail correctly (we test this because SMTP internals changed between 1.8.6 and newer versions of Ruby)" do
-      ActionMailer::Base.smtp_settings = {
-        :address => "smtp.gmail.com",
-        :port => 587,
-        :domain => "foo.com",
-        :authentication => :plain,
-        :user_name => "username",
-        :password => "password"
-      }
-      
-      capistrano = { :current_release => "/data/foo", :previous_release => "/data/foo", :cap_gun_email_envelope => {:recipients => ["joe@example.com"]} }
-      Net::SMTP.expects(:start)
-      CapGun::Mailer.deliver_deployment_notification capistrano
-    end
-  end
-  
-  describe "Mail envelope" do
-    before { CapGun::Mailer.any_instance.stubs(:create_body).returns("email body!") }
-    
-    it "gets recipients from email envelope" do
-      capistrano = { :cap_gun_email_envelope => { :recipients => ["foo@here.com", "bar@here.com"] } }
-      mail = CapGun::Mailer.create_deployment_notification capistrano
-      mail.to.should == ["foo@here.com", "bar@here.com"]
-    end
-
-    it "should have a default sender" do
-      capistrano = { :cap_gun_email_envelope => { :recipients => "foo@here.com" } }
-      mail = CapGun::Mailer.create_deployment_notification capistrano
-      mail.from.should == ["cap_gun@example.com"]
-    end
-    
-    it "should override sender from email envelope" do
-      capistrano = { :cap_gun_email_envelope => { :from => "booyakka!@example.com", :recipients => ["foo@here.com", "bar@here.com"] } }
-      mail = CapGun::Mailer.create_deployment_notification capistrano
-      mail.from.should == ["booyakka!@example.com"]
-    end
-  end
-  
-  describe "creating body" do
-    before do # make DateTime act as if local timezone is EDT
-      CapGun::Mailer.any_instance.stubs(:local_timezone).returns("EDT")
-      CapGun::Mailer.any_instance.stubs(:local_datetime_zone_offset).returns(Rational(-1,6))
-    end
-    
-    it "has a friendly summary line" do
-      CapGun::Mailer.any_instance.stubs(:current_user).returns("jdoe")
-      capistrano = { :application => "my app", :rails_env => "staging", :current_release => "/data/foo/releases/20080227120000",  :cap_gun_email_envelope => {} }
-      mail = CapGun::Mailer.create_deployment_notification capistrano
-      mail.subject.should == "[DEPLOY] my app deployed to staging" 
-      mail.body.split("\n").first.should == "my app was deployed to staging by jdoe at February 27th, 2008 8:00 AM EDT."
-    end
-
-    it "does not include rails env if not defined" do
-      CapGun::Mailer.any_instance.stubs(:current_user).returns("jdoe")
-      capistrano = { :application => "my app", :current_release => "/data/foo/releases/20080227120000", :cap_gun_email_envelope => {}}
-      mail = CapGun::Mailer.create_deployment_notification capistrano
-      mail.subject.should == "[DEPLOY] my app deployed" 
-      mail.body.split("\n").first.should == "my app was deployed by jdoe at February 27th, 2008 8:00 AM EDT."
-    end
-    
-  end
-  
-end