capistrano-mailgun 1.2.0 → 1.3.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2013-01-30 - v1.3.0
+ * added option to include list of servers deployed to in email notification
+ * fixed a bug where requiring `capistrano-mailgun` after you load `deploy.rb` would cause variables to be overwritten with defaults.
+ * don't call `mailgun.log_output` twice in html template
+ * fixed an issue where, depending on when `mailgun_notify` is called, it may or may not use the correct revisions when building the commit log.
+
 ## 2012-11-?? - v1.2.0
  * properly handle failures when running git-log
 

data/README.md

@@ -217,6 +217,18 @@ or with the built-in `mailgun_notify` task.
 
 See above `Disabling Emails` section for examples.
 
+### mailgun_include_servers
+
+Tnis variable is set to `false` by default. Setting to true will add the list of servers that are included in
+the `deploy:update_code` task, which is any server that got code deployed to it.
+
+This is useful for when you deploy to only a subset of servers using Capistrano's `HOSTS` or `ROLES` environment
+variables in your deploy.
+
+To enable the inclusion of the server list, you can add the following to your deployment configuration:
+
+    set :mailgun_include_servers, true
+
 ### github_url
 
 If your project is hosted on Github and you'd like to have links to the Github repository in the deployment

data/capistrano-mailgun.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/capistrano-mailgun/version', __FILE__)
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'capistrano-mailgun/version'
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Spike Grobstein"]

data/lib/capistrano-mailgun.rb

@@ -14,21 +14,32 @@ module Capistrano
 
         Capistrano.plugin :mailgun, Capistrano::Mailgun
 
-        set(:mailgun_subject) do
+        def _cset(name, *args, &block)
+          unless exists?(name)
+            set(name, *args, &block)
+          end
+        end
+
+        _cset(:mailgun_subject) do
           [ "[Deployment]", fetch(:stage, '').to_s.capitalize, fetch(:application, '').capitalize, 'deploy completed'].join(' ').gsub(/\s+/, ' ')
         end
 
-        set(:mailgun_api_key)           { abort "Please set mailgun_api_key accordingly" }
-        set(:mailgun_domain)            { abort "Please set mailgun_domain accordingly" }
-        set(:mailgun_from)              { abort "Please set mailgun_from to your desired From field" }
-        set(:mailgun_recipients)        { abort "Please specify mailgun_recipients" }
-        set(:mailgun_recipient_domain)  { abort "Please set mailgun_recipient_domain accordingly" }
+        _cset(:mailgun_api_key)           { abort "Please set mailgun_api_key accordingly" }
+        _cset(:mailgun_domain)            { abort "Please set mailgun_domain accordingly" }
+        _cset(:mailgun_from)              { abort "Please set mailgun_from to your desired From field" }
+        _cset(:mailgun_recipients)        { abort "Please specify mailgun_recipients" }
+        _cset(:mailgun_recipient_domain)  { abort "Please set mailgun_recipient_domain accordingly" }
+
+        # some internal variables that mailgun will use as the app runs
+        _cset(:mailgun_deploy_servers)    { find_servers_for_task( find_task('deploy:update_code') ) }
 
         # set these to nil to not use, or set to path to your custom template
-        set :mailgun_text_template, :deploy_text
-        set :mailgun_html_template, :deploy_html
+        _cset :mailgun_text_template, :deploy_text
+        _cset :mailgun_html_template, :deploy_html
 
-        set(:deployer_username) do
+        _cset :mailgun_include_servers, false
+
+        _cset(:deployer_username) do
           if fetch(:scm, '').to_sym == :git
             `git config user.name`.chomp
           else
@@ -36,6 +47,13 @@ module Capistrano
           end
         end
 
+        # before update_code, fetch the current revision
+        # this is needed to ensure that no matter when capistrano-mailgun fetches the commit logs that it
+        # has the correct starting point.
+        before 'deploy:update_code' do
+          set :mailgun_previous_revision, fetch(:current_revision, nil) # the revision that's currently deployed at this moment
+        end
+
         # default mailgun email tasks
         desc <<-DESC
           Send a mailgun deployment notification.
@@ -118,6 +136,8 @@ module Capistrano
       return @log_output unless @log_output.nil?
 
       begin
+        raise "Ref missing" if first_ref.nil? || last_ref.nil? # jump to resque block.
+
         log_output = run_locally("git log --oneline #{ first_ref }..#{ last_ref }")
 
         @log_output = log_output = log_output.split("\n").map do |line|

data/lib/capistrano-mailgun/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Mailgun
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

data/lib/templates/default.html.erb

@@ -124,13 +124,24 @@
     </div>
     <% end %>
 
-<% log_output = mailgun.log_output(latest_revision, real_revision) %>
+    <% if fetch(:mailgun_include_servers, false) %>
+    <div id="mailgun_servers" class="section">
+      <h2>Deployed to:</h2>
+      <ul>
+        <% fetch(:mailgun_deploy_servers).each do |server| %>
+          <li><%= server.host %></l>
+        <% end %>
+      </ul>
+    </div>
+    <% end %>
+
+<% log_output = mailgun.log_output(fetch(:mailgun_previous_revision, nil), fetch(:real_revision, nil)) %>
 <% unless log_output.count == 0 %>
     <div class="log">
       <h2>Log:</h2>
 
       <ul>
-        <% mailgun.log_output(latest_revision, real_revision).each do |line| %>
+        <% log_output.each do |line| %>
           <li>
             <% if fetch(:github_url, nil) && line[0] != 'n/a' %>
             <a href="<%= github_url %>/commit/<%= line[0] %>"><%= line[0] %></a>

data/lib/templates/default.txt.erb

@@ -16,7 +16,12 @@ Release:     <%= fetch(:release_name, 'N/A') %>
 <% end %>
 
 <% if fetch(:url, nil) %>WWW:         <%= fetch(:url) %><% end %>
-<% log_output = mailgun.log_output(latest_revision, real_revision) %>
+<% if fetch(:mailgun_include_servers, false) %>
+Deployed to the following servers:
+<% fetch(:mailgun_deploy_servers).each do |server| %> - <%= server.host %>
+<% end %>
+<% end %>
+<% log_output = mailgun.log_output(fetch(:mailgun_previous_revision, nil), fetch(:real_revision, nil)) %>
 <% unless log_output.count == 0 %>
 Log:
 ---------------------------------------------------------------------------------

data/spec/capistrano-mailgun_spec.rb

@@ -263,6 +263,85 @@ describe Capistrano::Mailgun do
 
   end
 
+  context "collecting deployment servers" do
+    let(:server_hostnames) { config.fetch(:mailgun_deploy_servers).map(&:host) }
+
+    before do
+      config.load do
+        load 'deploy'
+
+        set :application, 'rspec-app'
+        set :repository, 'foo'
+
+        set :current_revision, nil
+        set :latest_revision, ''
+        set :release_name, ''
+        set :real_revision, ''
+
+        role :web, 'server-a'
+        role :app, 'server-b'
+
+        role :web, 'server-c', :no_release => true
+      end
+    end
+
+    context "#mailgun_deploy_servers" do
+
+      it "should find servers that are included in 'deploy'" do
+        server_hostnames.count.should == 2
+        server_hostnames.should include('server-a')
+        server_hostnames.should include('server-b')
+      end
+
+      it "should not find servers that are not included in 'deploy'" do
+        server_hostnames.should_not include('server-c')
+      end
+    end
+
+    context "templates" do
+      let(:result) { mailgun.send(:process_send_email_options, { :text_template => :deploy_text, :html_template => :deploy_html }) }
+
+      before do
+        require 'capistrano/recipes/deploy/scm/git'
+        Capistrano::Deploy::SCM::Git.any_instance.stub(:query_revision => '')
+        mailgun.stub!(:log_output => [])
+      end
+
+      context "when mailgun_include_servers is set to true" do
+        before do
+          config.load { set :mailgun_include_servers, true }
+        end
+
+        it "should include the servers in the text template" do
+          result[:text].should match('server-a')
+        end
+
+        it "should include the servers in the html template" do
+          result[:html].should match('server-a')
+          result[:html].should match('mailgun_servers')
+        end
+
+      end
+
+      context "when mailgun_include_servers is set to false" do
+        before do
+          config.load { set :mailgun_include_servers, false }
+        end
+
+        it "should not include the servers in the text template" do
+          result[:text].should_not match('server-a')
+        end
+
+        it "should not include the servers in the html template" do
+          result[:html].should_not match('server-a')
+          result[:html].should_not match('mailgun_servers')
+        end
+      end
+
+    end
+
+  end
+
   context "#process_send_email_options" do
     let(:test_mailgun_domain) { 'example.com' }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-mailgun
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2013-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -81,18 +81,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2899719465359232847
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2899719465359232847
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -105,3 +99,4 @@ test_files:
 - spec/fixtures/text_body.erb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
+has_rdoc: