capistrano_mailer 3.3.0 → 4.0.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+# Copyright (c) 2009   9thBit LLC   (http://www.9thbit.net)
+# Copyright (c) 2007-8 Sagebit, LLC (http://www.sagebit.com)
+#
+# 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.

data/README.rdoc

@@ -0,0 +1,206 @@
+= Capistrano Mailer
+
+  * For Capistrano Deployment Email Notification 
+  * It is a Capistrano Plugin / Ruby Gem that requires ActionMailer
+  * It is MIT-LICENSE
+
+Ever wanted to be emailed whenever someone on the team does a cap deploy of trunk or some tag to some server.  
+Wouldn't it be nice to know about it every time a release was deployed?  For large rails projects this type of coordination is essential, 
+and this plugin makes sure everyone on the need to know list is notified when something new is deployed.
+
+This plugin/gem is an extension to Capistrano.
+
+That means it registers itself with Capistrano as a plugin and is therefore available to call in your recipes.
+
+If you are looking to roll your own email integration into capistrano then try this pastie:
+http://pastie.org/146264 (thanks to Mislav Marohnić).
+But if you want to take the easy road to riches then keep reading ;)
+ -- figurative "riches" of course, I promise nothing in return for your using this plugin
+
+Important Note:
+The first time you deploy to a server (a 'cold' deploy) capistrano mailer will cause an error because it uses capistrano's previous release variables, and when there are no previous releases capistrano throws an error.  In the next version this will be fixed, just don't have time at the moment.  If you would like to work on this 'first deploy' problem please fork my repo and work on it!
+
+== Home Page
+
+http://github.com/pboling/capistrano_mailer
+
+
+== Credit where Credit is Due
+
+  * Thanks to Dustin Deyoung of Sagebit, LLC (http://www.sagebit.com) for the beautiful HTML email templates.
+
+
+== Requirements
+
+  * at least Rails 1.2.6 (might work with older versions, but has not been tested)
+
+  * at least Capistrano 2.4.3 (might work with capistrano as old as 2.1.0, but has not been tested)
+
+  * Known to be compatible with SCMs as of version 3.1.2: Perforce, SVN, and Git
+
+  * Known to be compatible with, but does not require, the deprec gem.
+
+
+== Usage with Rails >= 3.x.x
+
+The > 4.x versions of this gem require at least Rails 3
+
+=== Installation
+
+Install as a gem:
+
+  [sudo] gem install capistrano_mailer
+
+== Usage with Rails <= 2.3.x
+
+=== Installation
+
+Install the latest Rails 2 compatible version of the gem:
+
+  [sudo] gem install capistrano_mailer -v 3.2.5
+
+=== Upgrading
+
+The 3.x versions of the gem will remain compatible with Rails 2.x
+
+From version 3.1.x to version 3.2.x
+
+1. Update the way CapistranoMailer is configured using the new method: CapMailer.configure (see Usage below).
+2. require the cap mailer config file (see Usage below)
+
+From version 2.1.0 to version 3.1.x:
+
+1. Update the way CapistranoMailer is configured using the new method: CapMailer.configure_capistrano_mailer (changed in later versions to just 'configure') (see Usage below).
+2. Update the require statement at the top of deploy.rb, see below (note for plugin change from capistrano_mailer to capistrano/mailer).
+3. Change the mailer.send to mailer.send_notification_email in your cap recipe.
+
+== Setup
+
+1. You need to have already setup capistrano in the project, including the 'capify .' command.
+
+2. Add this line to the top of your config/deploy.rb:
+
+  # For plugin:
+  #   You must make capistrano_mailer's libraries available in Ruby's load path.  This is one way to do that:
+  #   Add to the top of your config/deploy.rb file:
+  $:.unshift 'vendor/plugins/capistrano_mailer/lib'
+
+  # For frozen gem:
+  #   You must make capistrano_mailer's libraries available in Ruby's load path.  This is one way to do that:
+  #   Add to the top of your config/deploy.rb file:
+  $:.unshift 'vendor/gems/capistrano_mailer-x.x.x/lib'
+
+  # then for gem or plugin:
+  ####################################
+  # Capistrano Plugins go here
+  require 'capistrano/mailer'
+  #configure capistrano_mailer:
+  # The configuration file can go anywhere, but in past versions of the gem it was required to be in the config/ dir.
+  require 'config/cap_mailer_settings'
+  ####################################
+
+3. Configure Caistrano Mailer in the settings file required in step 2:
+
+  # If installed as a plugin might need the require here as well
+
+  ActionMailer::Base.delivery_method = :smtp # or :sendmail, or whatever
+  ActionMailer::Base.smtp_settings = { # if using :smtp
+      :address        => "mail.example.com",
+      :port           => 25,
+      :domain         => 'default.com',
+      :perform_deliveries => true,
+      :user_name      => "releases@example.com",
+      :password       => "mypassword",
+      :authentication => :login }
+  ActionMailer::Base.default_charset = "utf-8"# or "latin1" or whatever you are using
+
+  CapMailer.configure do |config|
+    config[:recipient_addresses]  = ["dev1@example.com"]
+    # NOTE: THERE IS A BUG IN RAILS 2.3.3 which forces us to NOT use anything but a simple email address string for the sender address.
+    # https://rails.lighthouseapp.com/projects/8994/tickets/2340
+    # Therefore %("Capistrano Deployment" <releases@example.com>) style addresses may not work in Rails 2.3.3
+    config[:sender_address]       = "deployment@example.com"
+    config[:subject_prepend]      = "[EMPTY-CAP-DEPLOY]"
+    config[:site_name]            = "Empty Example.com App"
+  end
+
+4. Add these two tasks to your deploy.rb:
+
+  namespace :show do
+    desc "Show some internal Cap-Fu: What's mah NAYM?!?"
+    task :me do
+      set :task_name, task_call_frames.first.task.fully_qualified_name
+      #puts "Running #{task_name} task"
+    end
+  end
+
+  namespace :deploy do
+    ...
+
+    desc "Send email notification of deployment (only send variables you want to be in the email)"
+    task :notify, :roles => :app do
+      show.me  # this sets the task_name variable
+      mailer.send_notification_email(self)
+    end
+
+    ...
+  end
+
+5. Make _sure_ you've defined `rails_env`, `repository`, `deploy_to`, `host`, and `application`.  `task_name` is defined by the show:me task above, and the others are defined behind the scenes by Capistrano!
+
+6. The only parameter to mailer.send_notification_email that is *required* is the first. _Minimally_ you need to define the capistrano variables:
+
+  :rails_env
+  :repository
+  :task_name (provided by the show:me task included in this readme)
+  :deploy_to
+  :host
+  :application
+     
+But there are tons of others - just take a look at lib/mailer/cap_mailer.rb.
+
+If anyone has a cool way of recording the *output* into a capistrano accessible variable,
+so that it can be shoved into the release email that would be an excellent contribution!
+
+7. Then add the hook somewhere in your deploy.rb:
+
+  after "deploy", "deploy:notify"
+
+8. Enjoy and Happy Capping!
+
+9. Customization
+
+If you want to use your own views you'll need to recreate the notification_email view:
+First you need to define where your templates are:
+
+  CapMailer.configure_capistrano_mailer do |config|
+    config[:template_root]      = "app/views/capistrano_mailer/"
+  end
+
+Then you'll need to create templates there called:
+  `notification_email.text.html.erb`
+and / or
+  `notification_email.text.plain.erb`
+
+Take a look at the templates that comes with the plugin to see how it is done (views/cap_mailer/...)
+
+== Authors
+
+Peter Boling (pboling) - Wrote original & maintainer
+Dave Nolan (textgoeshere) - lots of refactoring merged into 3.2 release
+Jason Rust (jrust) - Updated for Rails 3 compatibility
+
+== Contributors
+
+Dustin Deyoung - HTML Email Templates
+mixonix - SCMs compatibility
+greut - SCMs compatibility
+
+----------------------------------------------------------------------------------
+  This plugin started out as a collaboration between Sagebit, LLC (http://www.sagebit.com) and Peter Boling (http://www.peterboling.com).
+  Written initially while Peter Boling was working at Sagebit for use in various projects.
+
+  Author: Peter Boling, peter.boling at gmail dot com
+
+  Copyright (c) 2009-2011 Peter Boling of 9thBit LLC, released under the MIT license
+  Copyright (c) 2007-2008 Sagebit LLC, released under the MIT license

data/Rakefile

@@ -1,5 +1,35 @@
 require 'rake'
 require 'rake/testtask'
+require 'rdoc/task'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "capistrano_mailer"
+    gemspec.summary = "Capistrano Deployment Email Notification"
+    gemspec.description = %q{Capistrano Deployment Email Notification.  Keep the whole team informed of each release!}
+    gemspec.email = ["peter.boling@gmail.com", "dave@textgoeshere.org.uk", "jason@rustedcode.com"]
+    gemspec.homepage = "http://github.com/pboling/capistrano_mailer"
+    gemspec.authors = ["Peter Boling", "Dave Nolan", "Jason Rust"]
+    gemspec.add_dependency 'actionmailer'
+    gemspec.files = ["README.rdoc",
+             "capistrano_mailer.gemspec",
+             "lib/cap_mailer.rb",
+             "lib/capistrano/mailer.rb",
+             "Rakefile",
+             "MIT-LICENSE",
+             "views/cap_mailer/_section.html.erb",
+             "views/cap_mailer/_section.text.erb",
+             "views/cap_mailer/_section_custom.html.erb",
+             "views/cap_mailer/_section_custom.text.erb",
+             "views/cap_mailer/notification_email.html.erb",
+             "views/cap_mailer/notification_email.text.erb",
+             "VERSION.yml"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -13,9 +43,7 @@ Rake::TestTask.new(:test) do |t|
 end
 
 desc 'Generate documentation for the capistrano_mailer gem.'
-require 'rdoc'
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
+Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'capistrano_mailer'
   rdoc.options << '--line-numbers' << '--inline-source'

data/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:major: 4
+:minor: 0
+:patch: 0
+:build: !!null 

data/capistrano_mailer.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "capistrano_mailer"
+  s.version = "4.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Boling", "Dave Nolan", "Jason Rust"]
+  s.date = "2011-12-11"
+  s.description = "Capistrano Deployment Email Notification.  Keep the whole team informed of each release!"
+  s.email = ["peter.boling@gmail.com", "dave@textgoeshere.org.uk", "jason@rustedcode.com"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "capistrano_mailer.gemspec",
+    "lib/cap_mailer.rb",
+    "lib/capistrano/mailer.rb",
+    "views/cap_mailer/_section.html.erb",
+    "views/cap_mailer/_section.text.erb",
+    "views/cap_mailer/_section_custom.html.erb",
+    "views/cap_mailer/_section_custom.text.erb",
+    "views/cap_mailer/notification_email.html.erb",
+    "views/cap_mailer/notification_email.text.erb"
+  ]
+  s.homepage = "http://github.com/pboling/capistrano_mailer"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Capistrano Deployment Email Notification"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<actionmailer>, [">= 0"])
+    else
+      s.add_dependency(%q<actionmailer>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<actionmailer>, [">= 0"])
+  end
+end
+

data/lib/cap_mailer.rb

@@ -1,6 +1,5 @@
 class CapMailer < ActionMailer::Base
 
-  # In capistrano_mailer 4+ this uses ActiveSupport::InheritableOptions from Rails 3+
   @@default_base_config ||= {
     :sender_address           => %("#{(defined?(Rails) ? Rails.env.capitalize : defined?(RAILS_ENV) ? RAILS_ENV.capitalize : defined?(ENV) ? ENV['RAILS_ENV'] : "")} Capistrano Deployment" <capistrano.mailer@example.com>),
     :recipient_addresses      => [],
@@ -11,71 +10,66 @@ class CapMailer < ActionMailer::Base
     :sections                 => %w(deployment release_data source_control latest_release previous_release other_deployment_info extra_information),
     :site_name                => "",
     :email_content_type       => "text/html",
-    # In Capistrano 4+ template_root becomes template_path
-    :template_root            => "#{File.dirname(__FILE__)}/../views",
-    :template_prefixes        => { :success => nil, :failure => "failed" },
-    :attach_log_on            => :failure
+    :template_root            => "#{File.dirname(__FILE__)}/../views"
   }
 
   cattr_accessor :default_base_config
   attr_accessor  :config, :options
   attr_accessor  :date, :time, :inferred_command, :task_name, :repo_end
-
+  
   def self.configure(&block)
     yield @@default_base_config
   end
 
   def self.configure_capistrano_mailer(&block)
-    raise "'configure_capistrano_mailer' is deprecated.  Please update your capistrano_mailer configuration to use 'configure' instead of 'configure_capistrano_mailer'"
+    puts "Deprecated 'configure_capistrano_mailer'.  Please update your capistrano_mailer configuration to use 'configure' instead of 'configure_capistrano_mailer'"
   end
 
-  self.template_root = default_base_config[:template_root]
+  self.prepend_view_path default_base_config[:template_root]
 
   def self.reloadable?() false end
-
-  def config_from_cap_hash(cap, config = {})
-    default_base_config.dup.merge(config.reverse_merge({
-                                           :rails_env          => cap[:rails_env],
-                                           :host               => cap[:host],
-                                           :task_name          => cap[:task_name],
-                                           :application        => cap[:application],
-                                           :repository         => cap[:repository],
-                                           :scm                => cap[:scm],
-                                           :deploy_via         => cap[:deploy_via],
-                                           :deploy_to          => cap[:deploy_to],
-                                           :revision           => cap[:revision],
-                                           :real_revision      => cap[:real_revision],
-                                           :release_name       => cap[:release_name],
-                                           :version_dir        => cap[:version_dir],
-                                           :shared_dir         => cap[:shared_dir],
-                                           :current_dir        => cap[:current_dir],
-                                           :releases_path      => cap[:releases_path],
-                                           :shared_path        => cap[:shared_path],
-                                           :current_path       => cap[:current_path],
-                                           :release_path       => cap[:release_path],
-                                           :releases           => cap[:releases],
-                                           :current_release    => cap[:current_release],
-                                           :previous_release   => cap[:previous_release],
-                                           :current_revision   => cap[:current_revision],
-                                           :latest_revision    => cap[:latest_revision],
-                                           :previous_revision  => cap[:previous_revision],
-                                           :run_method         => cap[:run_method],
-                                           :latest_release     => cap[:latest_release]
-
-                                           #This does not appear to be a capistrano variable:
-                                           #:site_url           => cap[:site_url]
-                                         }))
-  end
-
+    
   def notification_email(cap, config = {}, *args)
-    @config = config_from_cap_hash(cap.is_a?(Array) ? cap.first : cap, config)
     @options = { :release_data => {}, :extra_information => {}, :data => {} }.merge(args.extract_options!)
-
+    @config  = default_base_config.merge(config.reverse_merge({
+          :rails_env          => cap.rails_env,
+          :host               => cap.host,
+          :task_name          => cap.task_name,
+          :application        => cap.application,
+          :repository         => cap.repository,
+          :scm                => cap.scm,
+          :deploy_via         => cap.deploy_via,
+          :deploy_to          => cap.deploy_to,
+          :revision           => cap.revision,
+          :real_revision      => cap.real_revision,
+          :release_name       => cap.release_name,
+          #This does not appear to be a capistrano variable:
+          #:release_notes      => cap.release_notes,
+          :version_dir        => cap.version_dir,
+          :shared_dir         => cap.shared_dir,
+          :current_dir        => cap.current_dir,
+          :releases_path      => cap.releases_path,
+          :shared_path        => cap.shared_path,
+          :current_path       => cap.current_path,
+          :release_path       => cap.release_path,
+          :releases           => cap.releases,
+          :current_release    => cap.current_release,
+          :previous_release   => cap.previous_release,
+          :current_revision   => cap.current_revision,
+          :latest_revision    => cap.latest_revision,
+          :previous_revision  => cap.previous_revision,
+          :run_method         => cap.run_method,
+          :latest_release     => cap.latest_release
+    
+          #This does not appear to be a capistrano variable:
+          #:site_url           => cap.site_url
+    }))
+    
     @date             = Date.today.to_s
     @time             = Time.now.strftime("%I:%M %p").to_s
     @inferred_command = "cap #{@config[:rails_env]} #{@config[:task_name]}"
     @task_name        = @config[:task_name] || "unknown"
-
+    
     repo  = @config[:repository]
     x     = repo.include?('/') ? repo.rindex('/') - 1 : repo.length
     front = repo.slice(0..x)
@@ -86,53 +80,17 @@ class CapMailer < ActionMailer::Base
     end
     @repo_end = repo.sub(front, '')
 
-    log = cap.fetch(:full_log)
-    fail_pattern = /^failed|rolling back/i
-    @job_status = (log =~ fail_pattern) ? :failure : cap.fetch(:mailer_status, :success)
-    template_prefix = @config[:template_prefixes][@job_status] ? "#{@config[:template_prefixes][@job_status]}." : ""
-    template_name = @config[:template_name] || "#{template_prefix}#{action_name}"
-
-    attach_log = case @config[:attach_log_on]
-      when Symbol, String
-        @job_status == @config[:attach_log_on].to_sym
-      when Array
-        @config[:attach_log_on].collect(&:to_sym).include? @job_status
-      else
-        false
+    body_data_hash.each_pair do |k, v|
+      self.instance_variable_set("@#{k}", v)
     end
 
-    # See: http://guides.rubyonrails.org/v2.3.11/action_mailer_basics.html#sending-emails-with-attachments
-    if attach_log
-      content_type    "multipart/mixed"
-
-      part "multipart/alternative" do |alternative|
-
-        alternative.part "text/html" do |html|
-          html.body = render_message("#{template_name}.html", body_data_hash)
-        end if @config[:email_content_type] == "text/html"
-
-        alternative.part "text/plain" do |plain|
-          plain.body = render_message("#{template_name}.plain", body_data_hash)
-        end if @config[:email_content_type] == "text/plain"
-
-      end
-
-      attachment :content_type => "text/plain",
-                 :body => log,
-                 :filename => "deploy-log-#{Time.now.strftime("%Y-%m-%d-%H%M%S")}.txt"
-    else
-      content_type  @config[:email_content_type]
-      body          body_data_hash
-    end
-
-    subject       "#{@job_status.to_s.upcase}: #{subject_line}"
-    recipients    @config[:recipient_addresses]
-    from          @config[:sender_address]
-
+    mail :subject       => subject_line,
+         :to            => @config[:recipient_addresses],
+         :from          => @config[:sender_address]
   end
 
   private
-
+  
     def subject_line
       #The subject prepend and append are useful for people to setup filters in mail clients.
       user = config[:user] ? " by #{config[:user]}" : ""