capistrano_mailer 4.0.1 → 4.0.2

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+*.gem
+doc
+.project
+.idea

data/CHANGELOG

@@ -0,0 +1,107 @@
+Version 4.0.2 2013-01-21
+- Git Release Notes by Mark Sim (marksim)
+- Style improvements by Bartłomiej Danek (bartekd)
+- Improved Readme by Peter Boling (pboling)
+
+Version 4.0.1 2011-12-11
+- Fixed issues with README
+
+Version 4.0.0 2011-12-11
+- Using the new way of sending a mail by passing the mail command a hash of options and setting instance variables. (jrust)
+- Using Notifier.email_name().deliver instead (jrust)
+- Using prepend_view_path for the template root (jrust)
+- Remove the content_type setting since just sends a multipart email.(jrust)
+- commented out the new release_notes variable, because even with version 2.9 of capistrano there was no cap method called release notes. (jrust)
+- file cleanup (pboling)
+- Improved Readme (pboling)
+
+Version 3.2.5 2010-04-29
+- Remove Active Support dependency
+
+Version 3.2.4 2010-01-13
+- Fixed subject line format (mail client filters are based on format of subject line)
+
+Version 3.2.3 2010-01-13
+- config[:user] is now optional.
+
+Version 3.2.2 2010-01-13
+- Improved Readme
+
+Version 3.2.1 2010-01-13
+- Added deprecation warning for configure_capistrano_mailer
+- commented :site_url, doesn't appear to be a native capistrano variable, if sent in will still be rendered.
+
+Version 3.2.0 textgoeshere fork
+- config/cap_mailer_settings.rb is not longer a hard coded configuration location requirement.
+- refactoring core cap mailer class
+
+Version 3.1.10 2010-01-07
+- included _section.text.erb view in gem manifest
+- text version of email should render the text partials, not html
+
+Version 3.1.9 2010-01-07
+- Fixed URL for capistrano_mailer repo on github in HTML email message
+
+Version 3.1.8 2010-01-07
+- Improved Readme
+
+Version 3.1.6 2009-11-10
+- Fixed installation instructions to reference gemcutter instead of github
+
+Version 3.1.3 2009-09-29
+- Added Git as known compatable SCM to readme
+- Credited Dustin Deyoung as Author of HTML Email templates
+- Removed MIT-LICENSE file from gemspec (because github refuses to build with it there)
+- Still trying to get github to build the gem
+
+Version 3.1.2 2009-09-25
+- Fixed footer copyright
+- Trying to get github to build the gem
+
+Version 3.1.1 2009-09-24
+- Added back compatability with svn which broke when fixing for perforce (thanks to Matthew Beale / mixonic)
+- Improved Readme for plugin installation.  Tested as a plugin.  Verified continued compatibility with Deprec.
+
+Version 3.1.0 2009-09-17
+- Added compatability with perforce (thanks to Andy Kock / ak47)
+
+Version 3.0.3 2009-09-03
+- Improved readme and upgrade instructions
+
+Version 3.0.2 2009-08-27
+- Fixed some typos in readme referencing outdated API
+
+Version 3.0.1 2009-08-21
+- removed a stray puts used in debugging
+
+Version 3.0.0 2009-08-19
+- turned into a gem
+- New API for configuration
+- improved email templates (hardened against crappy data)
+- added simple testing framwork and Rakefile
+- still compatible with deprec
+
+Version 2.1.0 2008-11-15
+- improved readme, and other stuff I don't remember
+
+Version 2.0.1 2008-07-30
+- Works when deploying to a server without capistrano installed
+- Updated README and WIKI (improved documentation)
+
+Version 2.0 2008-07-25
+- Works with Rails 2.1
+- Works with Capistrano 2.4.3
+- Added access to many of Capistrano's internal variables (~25) so the emails can be more informative
+- Added inferred_command, repo_end and some other derived variables that give more insight into a deployment
+- Parameters are now sent in a hash
+- Emails updated with new information
+- HTML email improved layout, and added styling (thanks to Dustin Deyoung @ Sagebit)
+
+Version 1.0.1 2008-03-26
+- Works with Rails 2.0.2
+- Works with Capistrano 2.1.0 - 2.2.0
+- Compatability with Deprec verified
+
+Version 1.0 2008-02-11
+- Works with Rails 2.0.2
+- Works with Capistrano 2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem 'capistrano-log_with_awesome'
+gem 'inline-style'

data/Gemfile.lock

@@ -0,0 +1,46 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    capistrano (2.12.0)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    capistrano-log_with_awesome (0.0.2)
+      capistrano (>= 2.5.14)
+    css_parser (1.2.6)
+      addressable
+      rdoc
+    facets (2.9.3)
+    ffi (1.3.1)
+    ffi (1.3.1-x86-mingw32)
+    highline (1.6.12)
+    inline-style (0.5.0)
+      css_parser
+      facets
+      maca-fork-csspool
+      nokogiri
+    json (1.7.6)
+    maca-fork-csspool (2.0.2)
+      ffi
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.5.2)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    nokogiri (1.5.6)
+    nokogiri (1.5.6-x86-mingw32)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  capistrano-log_with_awesome
+  inline-style

data/README.rdoc

@@ -1,187 +1,204 @@
-= 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 3.0 (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
-
-Switch to the rails2 branch (releases will be in 3.x range)
-
-== 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
+= Capistrano Mailer {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/pboling/capistrano_mailer] {<img src="http://api.coderwall.com/pboling/endorsecount.png" />}[http://coderwall.com/pboling]
+
+* 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 3.0 (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
+
+Switch to the rails2 branch (releases will be in 3.x range)
+
+== 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
+
+== Versioning
+
+This library aims to adhere to {Semantic Versioning 2.0.0}[http://semver.org/].
+Violations of this scheme should be reported as bugs. Specifically, 
+if a minor or patch version is released that breaks backward 
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will 
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a 
+dependency on this gem using the {Pessimistic Version Constraint}[http://docs.rubygems.org/read/chapter/16#page74] with two digits of precision. 
+
+For example:
+
+    spec.add_dependency 'capistrano_mailer', '~> 4.0'
+
+
+----------------------------------------------------------------------------------
+  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