capistrano-mailgun 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-mailgun.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Spike Grobstein
+
+MIT License
+
+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.md

@@ -0,0 +1,127 @@
+# Capistrano-Mailgun
+
+*Bust a cap in your deployment notifications*
+
+Send emails with erb template bodies easily from inside your capistrano recipes.
+
+Although built primarily for sending notification emails of deploys, it also includes nice helper methods
+for sending any kind of email via the Mailgun API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-mailgun'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-mailgun
+
+In your `Capfile`, add:
+
+    require 'capistrano-mailgun'
+
+## Quickstart
+
+To send a notification after deploy, add the following to your `deploy.rb` file:
+
+    require 'capistrano-mailgun'
+
+    set :mailgun_api_key, 'key-12345678901234567890123456789012' # your mailgun API key
+    set :mailgun_domain, 'example.com' # your mailgun email domain
+    set :mailgun_from, 'deployment@example.com' # who the email will appear to come from
+    set :mailgun_recipients, [ 'you@example.com', 'otherguy@example.com' ] # who will receive the email
+
+    # create an after:deploy hook
+    # pass it the path to an erb template.
+    # The erb template will have visibility into all your capistrano variables.
+    after(:deploy) { mailgun.notify_of_deploy File.join(File.dirname(__FILE__), 'mail.erb') }
+
+You should then create a `mail.erb` file in the same directory as `deploy.rb`:
+
+    <%= application %> has just been deployed by <%= deployer_name %>, yay!
+
+That's it. When you do a deploy, it should automatically send an email.
+
+## Capistrano Variables
+
+`capistrano-mailgun` leverages variables defined in Capistrano to reduce the amount of configuration
+you need to do. The following are all variables it supports:
+
+### mailgun_api_key (required)
+
+Your API key. This MUST include the `key-` prefix.
+
+### mailgun_domain (required)
+
+The domain of your Mailgun account. This is used when calling the API and is required.
+
+### mailgun_from (required for notify_of_deploy)
+
+The email address that your notifications will appear to come from (by default).
+
+### mailgun_recipients (required for notify_of_deploy)
+
+An array of email addresses who should recieve a notification when a deployment completes.
+
+You can optionally only specify just the part of the email address before the @ and `capistrano-mailgun` will
+automatically append the `mailgun_recipient_domain` to it. See `mailgun_recipient_domain`.
+
+### mailgun_recipient_domain
+
+The domain that will be automatically appended to incomplete email addresses in the `mailgun_recipients`.
+
+### mailgun_subject
+
+The subject to be used in deployment emails. This defaults to:
+
+    [Deployment] #{ application.capitalize } complete
+
+Setting this will override the default.
+
+## Function API
+
+`capistrano-mailgun` has a couple of methods to enable you to send emails easily. The following are the functions:
+
+### mailgun.notify_of_deploy(erb_path)
+
+Given a path to an erb template file, it will send an email to recipients specified using the above
+Capistrano variables.
+
+See Quickstart, above, for an example.
+
+### mailgun.send_email( template, subject, recipients, from_address )
+
+Given a path to a template, subject, recipients and a from\_address, send an email via the Mailgun API.
+
+This function exists for convenience if you want to change the default behavior or notify during other events
+triggered by Capistrano. `mailgun.send_email` adheres to the same behavior for recipients (automatically adding
+the domain to the email addresses) as the regular `mailgun.notify_of_deploy` function.
+
+The template will also be executed in the context of the recipe and will have access to everything that
+capistrano has access to.
+
+### deployer_username
+
+This is a default capistrano variable that is defined in the gyem. 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.
+
+## Limitations
+
+ * Only supports plain-text emails. This should be fixed in the next release.
+ * Only supports ERB for templates. This should be changed in a future release.
+ * Simpler support for specifying templates? Should not need to pass absolute path, hopefully.
+ * Extremely limited access to Mailgun parameters. Eventually I'd like to add support for better customization of this.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/capistrano-mailgun.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/capistrano-mailgun/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Spike Grobstein"]
+  gem.email         = ["spike@ticketevolution.com"]
+  gem.description   = %q{Notify of deploys and other actions using mailgun}
+  gem.summary       = %q{Notify of deploys and other actions using mailgun}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "capistrano-mailgun"
+  gem.require_paths = ["lib"]
+  gem.version       = Capistrano::Mailgun::VERSION
+end

data/lib/capistrano-mailgun/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Mailgun
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano-mailgun.rb

@@ -0,0 +1,64 @@
+require "capistrano-mailgun/version"
+require 'restclient'
+require 'erb'
+
+
+module Capistrano
+  module Mailgun
+
+    # simple wrapper for sending an email with a given template
+    def send_email(template, subject, recipients, from_address)
+      RestClient.post "https://api:#{ mailgun_api_key }@api.mailgun.net/v2/#{ mailgun_domain }/messages",
+        :from => from_address,
+        :to => build_recipients( recipients ).join(','),
+        :subject => subject,
+        :text => ERB.new( File.open( find_template(template), 'r' ).read ).result(self.binding)
+    end
+
+    # does a deploy notification leveraging variables defined in capistrano.
+    def notify_of_deploy(template_name)
+      send_email( template_name, mailgun_subject, build_recipients( mailgun_recipients ), mailgun_from )
+    end
+
+    # kinda unused function for locating a provided template
+    def find_template(t)
+      return t
+      File.join( File.dirname(__FILE__), t )
+    end
+
+    private
+
+    # regenerates the recipients list using hte mailgun_domain for any reciients without domains
+    def build_recipients(recipients)
+      recipients.map do |r|
+        if r.match /.+?@.+?$/
+          r
+        else
+          "#{ r }@#{ mailgun_recipient_domain }"
+        end
+      end
+    end
+
+  end
+end
+
+Capistrano::Configuration.instance.load do
+  Capistrano.plugin :mailgun, Capistrano::Mailgun
+
+  set(:mailgun_subject) { "[Deployment] #{ application.capitalize } completed" }
+
+  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" }
+
+  set(:deployer_username) do
+    if fetch(:scm, nil).to_sym == :git
+      `git config user.name`.chomp
+    else
+      `whoami`.chomp
+    end
+  end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-mailgun
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Spike Grobstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-11 00:00:00.000000000 Z
+dependencies: []
+description: Notify of deploys and other actions using mailgun
+email:
+- spike@ticketevolution.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-mailgun.gemspec
+- lib/capistrano-mailgun.rb
+- lib/capistrano-mailgun/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Notify of deploys and other actions using mailgun
+test_files: []
+has_rdoc: