capistrano-mailgun 1.3.0 → 2.0.0pre

data/Gemfile

@@ -3,6 +3,3 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in capistrano-mailgun.gemspec
 gemspec
 
-gem 'rake'
-gem 'rspec'
-gem 'awesome_print'

data/README.md

@@ -6,13 +6,15 @@ Mailgun.org is an excellent, API-driven email provider. So, bust out your nine,
 easily from inside your Capistrano recipes.
 
 `Capistrano::Mailgun` provides a simple interface for notifying of deploys, exposing your Capistrano
-variables to your ERB template built on top of a more robust public interface to the Mailgun API.
+variables to your ERB template built on top of a more robust public interface to the Mailgun API. It's built on
+top of [Capnotify](https://github.com/spikegrobstein/capnotify), so it's extensible via Capnotify plugins and
+accepts Capnotify configuration options.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-mailgun'
+    gem 'capistrano-mailgun', '~> 2.0'
 
 And then execute:
 
@@ -151,25 +153,6 @@ An array of email addresses who should be BCC'd when `mailgun.notify_of_deploy`
 follow the same rules as the `mailgun_recipients` variable with respect to the handling of unqualified
 eail addresses.
 
-### mailgun_text_template (required for notify_of_deploy)
-
-This is the path to the ERB template that `mailgun.notify_of_deploy` will use to create the text body of
-your email. This is only required if you do not use the `mailgun_html_template` variable. You can
-specify both text and html templates and the emails will contain the proper bodies where the client
-supports it.
-
-The default setting for this is `:deploy_text` which is a built-in template. See "Built-in Templates"
-below for more information.
-
-### mailgun_html_template (required for notify_of_deploy)
-
-This is the path to the ERB template that will be used to generate the HTML body of the email. It is only
-required if you do not specify the `mailgun_text_template` variable. You can specify both text and html
-templates and emails will contain the proper bodies where the client supports it.
-
-The default setting for this is `:deploy_html` which is a built-in template. See "Built-in Templates"
-below for more information.
-
 ### mailgun_recipient_domain
 
 The domain that will be automatically appended to incomplete email addresses in the `mailgun_recipients`.
@@ -217,28 +200,6 @@ 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
-notifications, set this. It should be in the following format:
-
-    https://github.com/USERNAME/PROJECT
-
-This is used for linking to commits from the log and linking to the Github page for the exact revision that
-was deployed.
-
 ## Capistrano Tasks
 
 ### mailgun_notify
@@ -283,11 +244,6 @@ documentation:
 
 http://documentation.mailgun.net/api-sending.html
 
-This function also takes the following additional options:
-
- * `:text_template` -- a path to an ERB template for the text body of the email.
- * `:html_template` -- a path to an ERB template for the HTML body of the email.
-
 The templates will have access to all of your Capistrano variables and anything else that Capistrano can see
 such as methods and Capistrano plugins (including `Capistrano::Mailgun`).
 
@@ -296,35 +252,6 @@ will be passed directly to the Mailgun API.
 
 No validation is done from this function, so errors from Mailgun will percolate up to you.
 
-### deployer_username
-
-This is a default capistrano variable that is defined in the gem. It will use the `git config user.name` if `scm` is
-configured as `:git` or use `whoami` if not. This is handy if you want to notify people of which user
-actually did the deployment.
-
-## Built-in Templates
-
-`Capistrano::Mailgun` comes with built-in templates for use with `mailgun.notify_of_deploy`. There are both HTML and Text
-templates which include information such as the sha1 and ref that has been deployed as well as logs of the last
-commits. Use of the Capistrano variable `github_url` will enable links back to the repository and direct links
-to the commits in the log.
-
-These files live inside the gem in the `lib/templates` directory, so feel free to pull them out, copy into
-your project and customize.
-
-By default, `mailgun.notify_of_deploy` sets `mailgun_text_template` to `:default_text` and `mailgun_html_template`
-to `:default_html`, which signals it to use these built-in templates. Overriding those variables with absolute
-paths to your own templates will signal mailgun to use those. Setting either variable to `nil` will prevent
-`mailgun.notify_of_deploy` from using anything for either the text or HTML portion of the email.
-
-## Limitations
-
- * Only supports ERB for templates. This should be changed in a future release.
- * Currently requires that ERB templates are on the filesystem. Future releases may allow for inline templates.
- * Support for VCSs other than `:git` is lacking. `Capistrano::Mailgun` has been built with git and Github in mind.
-   If anyone has interest in adding support for other another version control system, that would be great.
-   Using this with a VCS other than Git may yeild unpredictable results.
-
 ## Contributing
 
 1. Fork it
@@ -335,10 +262,13 @@ paths to your own templates will signal mailgun to use those. Setting either var
 
 ## Acknowledgements
 
+`Capistrano::Mailgun` is a [Capnotify](https://github.com/spikegrobstein/capnotify) extension. See Capnotify for additional
+configuration options.
+
 `Capistrano::Mailgun` is written by Spike Grobstein and is used in production at [Ticket Evolution](http://www.ticketevolution.com)
 
 `Capistrano::Mailgun` leverages the awesome email sending API of [Mailgun.org](http://mailgun.org). You should definitely check it out.
 
 ## License
 
-`Capistrano::Mailgun` is ©2012 Spike Grobstein and licensed under the MIT License. See `LICENSE` file.
+`Capistrano::Mailgun` is ©2012-2013 Spike Grobstein and licensed under the MIT License. See `LICENSE` file.

data/capistrano-mailgun.gemspec

@@ -16,6 +16,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Capistrano::Mailgun::VERSION
 
-  gem.add_dependency "capistrano"
+  gem.add_dependency "capnotify", '~> 0.2.0'
   gem.add_dependency "rest-client"
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'awesome_print'
 end

data/lib/capistrano-mailgun.rb

@@ -1,7 +1,5 @@
 require "capistrano-mailgun/version"
 require 'restclient'
-require 'erb'
-
 
 module Capistrano
   module Mailgun
@@ -11,6 +9,7 @@ module Capistrano
     # the library in a Capistrano recipe.
     def self.load_into(config)
       config.load do
+        require 'capnotify'
 
         Capistrano.plugin :mailgun, Capistrano::Mailgun
 
@@ -20,6 +19,7 @@ module Capistrano
           end
         end
 
+        # TODO: This should use capnotify's subject
         _cset(:mailgun_subject) do
           [ "[Deployment]", fetch(:stage, '').to_s.capitalize, fetch(:application, '').capitalize, 'deploy completed'].join(' ').gsub(/\s+/, ' ')
         end
@@ -30,30 +30,6 @@ module Capistrano
         _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
-        _cset :mailgun_text_template, :deploy_text
-        _cset :mailgun_html_template, :deploy_html
-
-        _cset :mailgun_include_servers, false
-
-        _cset(:deployer_username) do
-          if fetch(:scm, '').to_sym == :git
-            `git config user.name`.chomp
-          else
-            `whoami`.chomp
-          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.
@@ -66,6 +42,13 @@ module Capistrano
           mailgun.notify_of_deploy
         end
 
+        on(:load) do
+          capnotify.components.unshift(Capnotify::Component.new(:mailgun_message) do |c|
+            c.header = 'Mailgun Message'
+
+            c.content = fetch(:mailgun_message, nil)
+          end)
+        end
 
 
       end # config.load
@@ -73,10 +56,9 @@ module Capistrano
 
     # Simple wrapper for sending an email with a given template
     # 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.
+    # TODO: Maybe we should call this +mailgun_disarm+?
     def send_email(options)
       return if exists?(:mailgun_off)
       options = process_send_email_options(options)
@@ -89,9 +71,6 @@ module Capistrano
     # * +mailgun_recipients+
     # * +mailgun_from+
     # * +mailgun_subject+
-    # Requires one or both of the following:
-    # * +mailgun_text_template+
-    # * +mailgun_html_template+
     #
     # See README for explanations of the above variables.
     def notify_of_deploy
@@ -104,13 +83,6 @@ module Capistrano
       options[:cc] = fetch(:mailgun_cc) if fetch(:mailgun_cc, nil)
       options[:bcc] = fetch(:mailgun_bcc) if fetch(:mailgun_bcc, nil)
 
-      if fetch(:mailgun_text_template, nil).nil? && fetch(:mailgun_html_template, nil).nil?
-        abort "You must specify one (or both) of mailgun_text_template and mailgun_html_template to use notify_of_deploy"
-      end
-
-      options[:text_template] = fetch(:mailgun_text_template, nil)
-      options[:html_template] = fetch(:mailgun_html_template, nil)
-
       send_email options
     end
 
@@ -118,7 +90,7 @@ module Capistrano
     # Optionally, it will take a +default_domain+ which will automatically be appended to any unqualified recipients (eg: 'spike' => 'spike@example.com')
     def build_recipients(recipients, default_domain=nil)
       [*recipients].map do |r|
-        if r.match /.+?@.+?$/ # the email contains an @ so it's fully-qualified.
+        if r.match(/.+?@.+?$/) # the email contains an @ so it's fully-qualified.
           r
         else
           "#{ r }@#{ default_domain || fetch(:mailgun_recipient_domain) }"
@@ -126,71 +98,17 @@ module Capistrano
       end.uniq.sort.join(',')
     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?
-
-      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|
-          fields = line.split("\s", 2)
-          [ fields[0], fields[1] ]
-        end
-      rescue
-        [ [ 'n/a', 'Log output not available.' ] ]
-      end
-    end
-
     private
 
-    def default_deploy_text_template_path
-      default_template_path 'default.txt.erb'
-    end
-
-    def default_deploy_html_template_path
-      default_template_path 'default.html.erb'
-    end
-
-    def default_template_path(name)
-      File.join( File.dirname(__FILE__), 'templates', name)
-    end
-
-    def find_template(t)
-      case t
-      when :deploy_text then default_deploy_text_template_path
-      when :deploy_html then default_deploy_html_template_path
-      else
-        abort "Unknown template symbol: #{ t }" if t.is_a?(Symbol)
-        abort "Template not found: #{ t }" unless File.exists?(t)
-        t
-      end
-    end
-
     # apply templates and all that jazz
-    def process_send_email_options(options)
-      text_template = options.delete(:text_template)
-      html_template = options.delete(:html_template)
-
+    # TODO: technically, options should not be a blank hash. technically there should be at least a :to field
+    def process_send_email_options(options={})
       options[:to] = build_recipients(options[:to]) unless options[:to].nil?
       options[:cc] = build_recipients(options[:cc]) unless options[:cc].nil?
       options[:bcc] = build_recipients(options[:bcc]) unless options[:bcc].nil?
 
-      options[:text] = ERB.new( File.open( find_template(text_template) ).read ).result(self.binding) if text_template
-      options[:html] = ERB.new( File.open( find_template(html_template) ).read ).result(self.binding) if html_template
-
-      # clean up the text template a little
-      if options[:text]
-        options[:text].gsub! /^ +/, ''
-        options[:text].gsub! /\n{3,}/, "\n\n"
-      end
+      options[:text] = fetch(:capnotify_deployment_notification_text) if fetch(:capnotify_deployment_notification_text_template_path, nil)
+      options[:html] = fetch(:capnotify_deployment_notification_html) if fetch(:capnotify_deployment_notification_html_template_path, nil)
 
       options
     end

data/lib/capistrano-mailgun/version.rb

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

data/spec/capistrano-mailgun_spec.rb

@@ -9,7 +9,13 @@ describe Capistrano::Mailgun do
   before do
     Capistrano::Mailgun.load_into(config)
 
+    config.load do
+      set :application, 'testapp'
+    end
+
     RestClient.stub(:post)
+
+    config.trigger(:load)
   end
 
   let(:mailgun) { config.mailgun }
@@ -66,53 +72,6 @@ describe Capistrano::Mailgun do
 
   end
 
-  context "#find_template" do
-
-    def find_template(t)
-      mailgun.send(:find_template, t)
-    end
-
-    context "when dealing with a path" do
-
-      it "should return the path if the file exists" do
-        File.stub!(:exists? => true)
-
-        find_template('asdf').should == 'asdf'
-      end
-
-      it "should not raise an error if the file exists" do
-        File.stub!(:exists? => true)
-
-        lambda { find_template('adsf') }.should_not raise_error
-      end
-
-      it "should raise an error if the path doesn't exist" do
-        File.stub!(:exists? => false)
-
-        lambda { find_template('asdf') }.should raise_error
-      end
-
-    end
-
-    context "when dealing with a symbol" do
-
-      it "should return the default_deploy_text_template_path for :deploy_text" do
-        mailgun.should_receive(:default_deploy_text_template_path)
-
-        find_template(:deploy_text)
-      end
-
-      it "should return the default_deploy_html_template_path for :deploy_html" do
-        mailgun.should_receive(:default_deploy_html_template_path)
-
-        find_template(:deploy_html)
-      end
-
-    end
-
-  end
-
-
   context "when ensuring cap variables are defined" do
 
     def should_require(var)
@@ -288,12 +247,14 @@ describe Capistrano::Mailgun do
     context "#mailgun_deploy_servers" do
 
       it "should find servers that are included in 'deploy'" do
+        pending
         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
+        pending
         server_hostnames.should_not include('server-c')
       end
     end
@@ -313,10 +274,12 @@ describe Capistrano::Mailgun do
         end
 
         it "should include the servers in the text template" do
+          pending
           result[:text].should match('server-a')
         end
 
         it "should include the servers in the html template" do
+          pending
           result[:html].should match('server-a')
           result[:html].should match('mailgun_servers')
         end
@@ -329,10 +292,12 @@ describe Capistrano::Mailgun do
         end
 
         it "should not include the servers in the text template" do
+          pending
           result[:text].should_not match('server-a')
         end
 
         it "should not include the servers in the html template" do
+          pending
           result[:html].should_not match('server-a')
           result[:html].should_not match('mailgun_servers')
         end
@@ -349,56 +314,8 @@ describe Capistrano::Mailgun do
       config.load { set :mailgun_domain, 'example.com' }
     end
 
-    it "should set text to the rendered text template if text_template is passed" do
-      result = mailgun.send(:process_send_email_options, :text_template => fixture_path('text_body.erb'))
-
-      result[:text].should include(test_mailgun_domain)
-      result[:text].should_not include('<%=')
-    end
-
-    it "should not change text if no text_template is passed" do
-      ERB.should_not_receive(:new)
-      File.should_not_receive(:open)
-
-      mailgun.send(:process_send_email_options, :text => 'normal text')[:text].should == 'normal text'
-    end
-
-    it "should set html to the rendered html template if html_template is passed" do
-      result = mailgun.send(:process_send_email_options, :html_template => fixture_path('html_body.erb'))
-
-      result[:html].should include(test_mailgun_domain)
-      result[:html].should_not include('<%=')
-    end
-
-    it "should not change html if no html_template is passed" do
-      ERB.should_not_receive(:new)
-      File.should_not_receive(:open)
-
-      mailgun.send(:process_send_email_options, :html => 'normal html')[:html].should == 'normal html'
-    end
-
-  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
+    it "should not return :text field if capnotify_deployment_notification_text_template is unset"
+    it "should not return :html field if capnotify_deployment_notification_html_template is unset"
 
   end
 

data/spec/integration_spec.rb

@@ -10,6 +10,8 @@ describe "Integration testing for Capistrano::Mailgun" do
     Capistrano::Mailgun.load_into(config)
 
     RestClient.stub(:post)
+
+    config.trigger(:load)
   end
 
   let(:mailgun) { config.mailgun }
@@ -47,9 +49,7 @@ describe "Integration testing for Capistrano::Mailgun" do
 
 
       it "should allow user to unset text template" do
-        config.load do
-          set :mailgun_text_template, nil
-        end
+        config.set :capnotify_deployment_notification_text_template_path, nil
 
         RestClient.should_receive(:post) do |url, opts|
           opts.has_key?(:text).should be_false
@@ -58,9 +58,7 @@ describe "Integration testing for Capistrano::Mailgun" do
       end
 
       it "should allow user to unset html template" do
-        config.load do
-          set :mailgun_html_template, nil
-        end
+        config.set :capnotify_deployment_notification_html_template_path, nil
 
         RestClient.should_receive(:post) do |url, opts|
           opts.has_key?(:text).should be_true
@@ -141,9 +139,7 @@ describe "Integration testing for Capistrano::Mailgun" do
 
       context "when using mailgun_message" do
         it "should include a mailgun_message if set" do
-          config.load do
-            set :mailgun_message, '_custom_message_'
-          end
+          config.set :mailgun_message, '_custom_message_'
 
           RestClient.should_receive(:post) do |url, opts|
             opts[:text].should include('_custom_message_')

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ $: << File.dirname(__FILE__) + '/../lib'
 
 require 'capistrano'
 require 'capistrano-mailgun'
+require 'pry'
 
 def fixture_path(filename)
   File.join( File.dirname(__FILE__), 'fixtures', filename )

metadata

@@ -1,18 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-mailgun
 version: !ruby/object:Gem::Version
-  version: 1.3.0
-  prerelease: 
+  version: 2.0.0pre
+  prerelease: 5
 platform: ruby
 authors:
 - Spike Grobstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: capistrano
+  name: capnotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -28,14 +44,46 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -84,9 +132,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24