capistrano-mailgun 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## 2012-10-?? - v1.1.0
+## 2012-11-?? - v1.2.0
+ * properly handle failures when running git-log
+
+## 2012-10-22 - v1.1.0
  * default subject now includes stage
  * built-in templates
  * support for custom messages

data/README.md

@@ -95,6 +95,24 @@ above is just an example.
 
 Also, notice the use of `mailgun.build_recipients`. See documentation below for more information.
 
+## Disabling Emails
+
+If you want to prevent sending any email notifications for any reason, you can set the `mailgun_off`
+Capistrano variable either via the `set` command or with the `-s` commandline options when calling
+`cap`.
+
+If using the Capistrano multistage plugin, you can put the following into one of your stage files
+that you want to disable notifications for:
+
+    set :mailgun_off, true
+
+Or, when doing a normal deploy and you want to prevent notifications for this deploy, you can do the
+following:
+
+    cap deploy -s mailgun_off=1
+
+Heads up: Setting `mailgun_off` to **anything** will disable emails. This includes setting it to `false`.
+
 ## Capistrano Variables
 
 `Capistrano::Mailgun` leverages variables defined in Capistrano to reduce the amount of configuration
@@ -191,6 +209,14 @@ You would call it in the following manner:
 
     cap deploy -s mailgun_message="Fixes that really nasty bug where our site does not work"
 
+### mailgun_off
+
+Setting `mailgun_off` to any value, either via the `-s` commandline switch or with `set` in your recipe
+will completely disable any Mailgun notifications, regardless of whether they're sent with `mailgun.send_email`
+or with the built-in `mailgun_notify` task.
+
+See above `Disabling Emails` section for examples.
+
 ### github_url
 
 If your project is hosted on Github and you'd like to have links to the Github repository in the deployment

data/lib/capistrano-mailgun.rb

@@ -57,7 +57,10 @@ module Capistrano
     # Supports all options that the Mailgun API supports. In addition, it also accepts:
     # * +:text_template+ -- the path to the template for the text body. It will be processed and interpolated and set the +text+ field when doing the API call.
     # * +:html_template+ -- the path to the template for the html body. It will be processed and interpolated and set the +html+ field when doing the API call.
+    #
+    # If +mailgun_off+ is set, this function will do absolutely nothing.
     def send_email(options)
+      return if exists?(:mailgun_off)
       options = process_send_email_options(options)
 
       RestClient.post build_mailgun_uri( mailgun_api_key, mailgun_domain ), options
@@ -106,14 +109,23 @@ module Capistrano
     end
 
     # git log between +first_ref+ to +last_ref+
+    # memoizes the output so this function can be called multiple times without re-running
+    # FIXME: memoization does not account for arguments
+    #
+    # returns an array of 2-element arrays in the form of
+    # [ ref, log_text ]
     def log_output(first_ref, last_ref)
       return @log_output unless @log_output.nil?
 
-      log_output = run_locally("git log --oneline #{ first_ref }..#{ last_ref }")
+      begin
+        log_output = run_locally("git log --oneline #{ first_ref }..#{ last_ref }")
 
-      @log_output = log_output = log_output.split("\n").map do |line|
-        fields = line.split("\s", 2)
-        [ fields[0], fields[1] ]
+        @log_output = log_output = log_output.split("\n").map do |line|
+          fields = line.split("\s", 2)
+          [ fields[0], fields[1] ]
+        end
+      rescue
+        [ [ 'n/a', 'Log output not available.' ] ]
       end
     end
 

data/lib/capistrano-mailgun/version.rb

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

data/lib/templates/default.html.erb

@@ -132,7 +132,7 @@
       <ul>
         <% mailgun.log_output(latest_revision, real_revision).each do |line| %>
           <li>
-            <% if fetch(:github_url, nil) %>
+            <% if fetch(:github_url, nil) && line[0] != 'n/a' %>
             <a href="<%= github_url %>/commit/<%= line[0] %>"><%= line[0] %></a>
             <% else %>
             <%= line[0] %>

data/spec/capistrano-mailgun_spec.rb

@@ -140,6 +140,37 @@ describe Capistrano::Mailgun do
       end
     end
 
+    context "mailgun_off" do
+
+      context "when it is set" do
+        before do
+          config.load do
+            set :mailgun_off, true
+          end
+
+          mailgun.stub!(:proces_send_email_options => true)
+        end
+
+        it "should not send emails when mailgun_off is set" do
+          RestClient.should_not_receive(:post)
+          mailgun.send_email({})
+        end
+
+      end
+
+      context "when it is not set" do
+        before do
+          mailgun.stub!(:process_send_email_options => true)
+        end
+
+        it "should send emails when mailgun_off is not set" do
+          RestClient.should_receive(:post)
+          mailgun.send_email({})
+        end
+      end
+
+    end
+
   end
 
   context "#notify_of_deploy" do
@@ -269,4 +300,27 @@ describe Capistrano::Mailgun do
 
   end
 
+  context "#log_output" do
+
+    context "when it raises an error" do
+
+      before do
+        mailgun.should_receive(:run_locally).and_raise(Capistrano::LocalArgumentError.new)
+      end
+
+      it "should only return a 1-element array if an error is returned from git-log" do
+        result = mailgun.log_output('a', 'b')
+
+        result.class.should == Array
+        result.length.should == 1
+      end
+
+      it "should capture the error and not raise if git-log fails" do
+        lambda { mailgun.log_output('a', 'b') }.should_not raise_error
+      end
+
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-mailgun
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -83,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4576376367349129326
+      hash: -2899719465359232847
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4576376367349129326
+      hash: -2899719465359232847
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24