capistrano3-notifier 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c6b26db000c8cc4076ac491f8345825a1b226c7
+  data.tar.gz: 940bd24c608aec2c7e8d3efb32ddc884626296d6
+SHA512:
+  metadata.gz: 62c6d92d9f4e3152690cc87066cbe94d5e526f6be259a103527c169b5e3d9e5eda247d5c5e447c825381c171aaef02cca177432f7b752609bc87bd67fbd97ca0
+  data.tar.gz: 86fdd5549c72fe58d3008884fb6e60b6a9b3ed21b336f3a8be4d382be0d40f3e187eea295085d6dc5c4b5a531aaa110b81ce4699b2cd2429df0344ffa0f75634

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.1.5
+  - 2.2.0
+script: bundle exec rake spec
+cache: bundler

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Justin Campbell
+
+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,138 @@
+# Capistrano3 Notifier [![Build Status](https://secure.travis-ci.org/applicaster/capistrano3-notifier.png)](https://secure.travis-ci.org/applicaster/capistrano3-notifier)
+
+##Rewrite of [Capistrano Notifier](https://github.com/gofullstack/capistrano-notifier) Gem for Capistrano3
+
+## Install
+
+In your Gemfile:
+
+```rb
+gem 'capistrano3-notifier'
+```
+
+and then `bundle install`
+
+`cap` needs to be invoked with Bundler for the `require` statements
+below to work properly. You can do so with either `bundle exec cap`, or
+with `bundle install --binstubs` and making sure `bin` is high up in your
+`$PATH`.`
+
+
+## Mail
+
+```rb
+require 'capistrano/notifier/mail'
+
+set :notifier_mail_options, {
+  method: :test, # :smtp, :sendmail, or any other valid ActionMailer delivery method
+  from: 'capistrano@domain.com',
+  to: ['john@doe.com', 'jane@doe.com'],
+  subject: "Successfully deployed #{application.titleize} to #{stage}", # OPTIONAL
+  github: 'MyCompany/project-name'
+}
+```
+
+If you specified `method: :test`, you can see the email that would be
+generated in your console with `cap deploy:notify:mail`.
+
+If you specified `method: :smtp`, you can specify `:smtp_settings`
+
+For example:
+
+```rb
+set :notifier_mail_options, {
+  method: :smtp,
+  from: 'capistrano@domain.com',
+  to: ['john@doe.com', 'jane@doe.com'],
+  github: 'MyCompany/project-name',
+  smtp_settings: {
+    address: "smtp.gmail.com",
+    port: 587,
+    domain: "gmail.com",
+    authentication: "plain",
+    enable_starttls_auto: true,
+    user_name: MY_USERNAME,
+    password: MY_PASSWORD
+  }
+}
+```
+
+### Templates
+
+This gem comes with two different ERB templates that are used to generate the body of the email. To choose from each one of them, you can set the `format` option to either `:html` - for HTML emails - or `:text` - for plain text.
+
+The following are the default values for the template options:
+
+ - `format`: `:text`
+ - `templates_path`: `"config/deploy/templates"`
+ - `template`: `"mail.#{format}.erb"`. Note the dependency of this option on `format`.
+
+The relationship between these variables might seem a bit complex but provides great flexibility. The logic used is as follows:
+
+ - If the file exists in `"#{templates_path}/#{template}"`, then use that one. With no option set, this will default to `config/deploy/templates/mail.text.erb`.
+
+ - If the file doesn't exist in the previous path, load `"#{template}"` from one of the gem's templates, either `mail.text.erb` or `mail.html.erb`. With no options set, this will default to `mail.text.erb` due to how the `template` option is generated. See above.
+
+For those interested in creating customized templates, it is important to know that you can use any of the variables defined in capistrano by prefixing it with the `cap` method like below:
+
+```rb
+<%= fetch(:any_variable_defined_in_capistrano) %>
+```
+
+The following is a list of some popular variables that don't require the use of the `cap.` prefix:
+
+ - `application`: Name of the application.
+ - `branch`: Name of the branch to be deployed.
+ - `git_commit_prefix`: URL of the format `"#{git_prefix}/commit"`.
+ - `git_compare_prefix`: URL of the format `"#{git_prefix}/compare"`.
+ - `git_current_revision`: Commit for current revision.
+ - `git_log`: Simplified log of commits in the `git_range`.
+ - `git_prefix`: URL to the github repository. Depends on `giturl` or `github` variables.
+ - `git_previous_revision`: Commit for previous revision.
+ - `git_range`: Range of commits between previous and current revision. Example: xxx..yyy
+ - `github_range`: Range of commits between previous and current revision in GitHub format. Example: xxx...yyy
+ - `github`: URL path to the GitHub respository. Ex: 'MyCompany/project-name'.
+ - `giturl`: Base URL to the repository.
+ - `now`: Current time.
+ - `stage`: Name of the stage from the capistrano multistage extension.
+ - `user_name`: Name of the local git author.
+
+## StatsD
+
+```rb
+require 'capistrano/notifier/statsd'
+```
+
+A counter of 1 will be sent with the key `application.stage.deploy` if using
+multistage, or `application.deploy` if not. To use a gauge instead of a counter,
+use `with: :gauge`:
+
+```rb
+set :notifier_statsd_options, {
+  with: :gauge
+}
+```
+
+If you want to specify a host:port other than
+127.0.0.1:8125, you can do so like this:
+
+```rb
+set :notifier_statsd_options, {
+  host: "10.0.0.1",
+  port: "8125"
+}
+```
+
+You can define the pattern that will be used to define the key.
+In the example the key will be 'test.deployment.example'
+
+```rb
+set :application, 'example'
+set :stage,       'test'
+
+set :notifier_statsd_options, {
+  pattern: "#{stage}.deployment.#{application}"
+}
+```
+
+The `nc` ([Netcat](http://netcat.sourceforge.net/)) command is used to send messages to statsd and must be installed on the remote hosts. This is installed by default on most Unix machines.

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'bundler/gem_tasks'
+rescue LoadError
+  puts "Ruby >= 1.9 required for build tasks"
+end
+
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc "Run the test suite"
+RSpec::Core::RakeTask.new
+

data/capistrano3-notifier.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/capistrano/notifier/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Justin Campbell", "Nathan L Smith", "Vitaly Gorodetsky"]
+  gem.email         = ["sysadmin@cramerdev.com"]
+  gem.summary       = %q{Capistrano3 Notifier}
+  gem.description   = %q{Simple notification hooks for Capistrano3}
+  gem.homepage      = "http://github.com/cramerdev/capistrano-notifier"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- spec/*`.split("\n")
+  gem.name          = "capistrano3-notifier"
+  gem.require_paths = ["lib"]
+  gem.version       = Capistrano::Notifier::VERSION
+
+  gem.add_dependency 'actionmailer', '~> 4.0'
+  gem.add_dependency 'capistrano', '~> 3.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'timecop'
+  gem.add_development_dependency 'pry'
+end

data/lib/capistrano/notifier/helpers/mail.rb

@@ -0,0 +1,135 @@
+module Capistrano
+  module Notifier
+    module Helpers
+      module Mail
+        def application
+          fetch :application
+        end
+
+        def branch
+          fetch(:branch, "master")
+        end
+
+        def git_current_revision
+          fetch :current_revision
+        end
+
+        def git_previous_revision
+          fetch :previous_revision
+        end
+
+        def git_range(ranger = "..")
+          return unless git_previous_revision && git_current_revision
+          "#{git_previous_revision}#{ranger}#{git_current_revision}"
+        end
+
+        def github_range
+          git_range("...")
+        end
+
+        def git_log_command
+          notifier_mail_options[:log_command]
+        end
+
+        def git_log
+          return unless git_range
+          command =
+            git_log_command || 'git log #{git_range} --no-merges --format=format:"%h %s (%an)"'
+
+          system_call(command)
+        end
+
+        def now
+          @now ||= Time.now
+        end
+
+        def stage
+          fetch :stage
+        end
+
+        def user_name
+          ENV['DEPLOYER'] || system_call("git config --get user.name").strip
+        end
+
+        def notifier_mail_options
+          @notifier_mail_options ||= fetch :notifier_mail_options
+        end
+
+        def email_format
+          notifier_mail_options[:format] || :text
+        end
+
+        def email_template
+          notifier_mail_options[:template] || "mail.#{email_format.to_s}.erb"
+        end
+
+        def email_from
+          notifier_mail_options[:from]
+        end
+
+        def github
+          notifier_mail_options[:github]
+        end
+
+        def giturl
+          notifier_mail_options[:giturl]
+        end
+
+        def git_prefix
+          giturl ? giturl : "https://github.com/#{github}"
+        end
+
+        def git_commit_prefix
+          "#{git_prefix}/commit"
+        end
+
+        def git_compare_prefix
+          "#{git_prefix}/compare"
+        end
+
+        def delivery_method
+          notifier_mail_options[:method]
+        end
+
+        def notifier_smtp_settings
+          notifier_mail_options[:smtp_settings]
+        end
+
+        def email_subject
+          notifier_mail_options[:subject] ||
+            "#{application} branch #{branch} deployed to #{stage}"
+        end
+
+        def render_template(template_name)
+          config_file = "#{templates_path}/#{template_name}"
+
+          unless File.exists?(config_file)
+            config_file = File.join(File.dirname(__FILE__),'..', "templates/#{template_name}")
+          end
+
+          ERB.new(File.read(config_file), nil, '-').result(binding)
+        end
+
+        def templates_path
+          notifier_mail_options[:templates_path] || 'config/deploy/templates'
+        end
+
+        def email_text
+          render_template(email_template)
+        end
+
+        def email_to
+          notifier_mail_options[:to]
+        end
+
+        def content_type_for_format(format = nil)
+          format == :html ? 'text/html' : 'text/plain'
+        end
+
+        def system_call(command)
+          `#{command}`
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/notifier/helpers/statsd.rb

@@ -0,0 +1,68 @@
+module Capistrano
+  module Notifier
+    module Helpers
+      module StatsD
+        def application
+          fetch :application
+        end
+
+        def stage
+          fetch :stage
+        end
+
+        def notifier_statsd_options
+          @notifier_statsd_options ||= fetch :notifier_statsd_options
+        end
+
+        def statsd_defaults
+          { host: "127.0.0.1", port: "8125", with: :counter }
+        end
+
+        def statsd_host
+          statsd_options[:host]
+        end
+
+        def statsd_options
+          @statsd_options ||= if notifier_statsd_options
+                                statsd_defaults.merge notifier_statsd_options
+                              else
+                                statsd_defaults
+                              end
+        end
+
+        def statsd_packet
+          "#{statsd_pattern}:#{statsd_with}".gsub('|', '\\|')
+        end
+
+        def statsd_pattern
+          statsd_options.fetch(:pattern){ statsd_default_pattern }
+        end
+
+        def statsd_default_pattern
+          if stage
+            "#{application}.#{stage}.deploy"
+          else
+            "#{application}.deploy"
+          end
+        end
+
+        def statsd_port
+          statsd_options[:port]
+        end
+
+        def statsd_with
+          case statsd_options[:with]
+          when :counter
+            "1|c"
+          when :gauge
+            "1|g"
+          end
+        end
+
+        def statsd_notifier_command
+          "echo -n #{statsd_packet} | nc -w 1 -u #{statsd_host} #{statsd_port}"
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/notifier/mail.rb

@@ -0,0 +1,28 @@
+require 'action_mailer'
+require 'capistrano/notifier/helpers/mail'
+include Capistrano::Notifier::Helpers::Mail
+
+namespace :deploy do
+  namespace :notify do
+    desc "Send a deployment notification via email."
+    task :mail do
+      run_locally do
+        ActionMailer::Base.smtp_settings = notifier_smtp_settings
+        ActionMailer::Base.mail({
+          body: email_text,
+          delivery_method: delivery_method,
+          content_type: content_type_for_format(email_format),
+          from: email_from,
+          subject: email_subject,
+          to: email_to
+        }).deliver
+
+        if delivery_method == :test
+          puts ActionMailer::Base.deliveries
+        end
+      end
+    end
+  end
+end
+
+after "deploy:updated", "deploy:notify:mail"

data/lib/capistrano/notifier/statsd.rb

@@ -0,0 +1,15 @@
+require 'capistrano/notifier/helpers/statsd'
+include Capistrano::Notifier::Helpers::StatsD
+
+namespace :deploy do
+  namespace :notify do
+    desc "Notify StatsD of deploy."
+    task :statsd do
+      on roles(:app) do |host|
+        execute statsd_notifier_command
+      end
+    end
+  end
+end
+
+after "deploy:updated", "deploy:notify:statsd"

data/lib/capistrano/notifier/templates/mail.html.erb

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+  </head>
+  <body leftmargin="0" marginwidth="0" topmargin="0" marginheight="0" offset="0">
+    <h3>Details:</h3>
+    <table>
+      <tbody>
+        <tr>
+          <td><strong>Deployer:</strong></td>
+          <td><%= user_name %></td>
+        </tr>
+        <tr>
+          <td><strong>Application:</strong></td>
+          <td><%= application %></td>
+        </tr>
+        <tr>
+          <td><strong>Branch:</strong></td>
+          <td><%= branch %></td>
+        </tr>
+        <tr>
+          <td><strong>Environment:</strong></td>
+          <td><%= stage %></td>
+        </tr>
+        <tr>
+          <td><strong>Time:</strong></td>
+          <td><%= now.strftime("%m/%d/%Y") %> at <%= now.strftime("%H:%M %Z") %></td>
+        </tr>
+      </tbody>
+    </table>
+
+    <h3>Compare:</h3>
+    <p><%= git_compare_prefix %>/<%= github_range %></p>
+
+    <h3>Commits:</h3>
+    <%- git_log.split(/\n/).each do |commit| -%>
+      <p><%= commit %></p>
+    <%- end if git_log -%>
+
+  </body>
+</html>

data/lib/capistrano/notifier/templates/mail.text.erb

@@ -0,0 +1,11 @@
+Deployer:     <%= user_name %>
+Application:  <%= application %>
+Branch:       <%= branch %>
+Environment:  <%= stage %>
+Time:         <%= now.strftime("%m/%d/%Y") %> at <%= now.strftime("%H:%M %Z") %>
+
+Compare:
+<%= git_compare_prefix %>/<%= github_range %>
+
+Commits:
+<%= git_log %>

data/lib/capistrano/notifier/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Notifier
+    VERSION = '0.5.0'
+  end
+end

data/spec/fixtures/templates/mail.text.erb

@@ -0,0 +1,4 @@
+Application:  <%= application %>
+
+Compare:
+<%= git_compare_prefix %>/<%= github_range %>

data/spec/integration/capistrano/notifier/mail_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'capistrano/setup'
+require 'capistrano/deploy'
+require 'capistrano/notifier/mail'
+
+describe "deploy:notify:mail" do
+  before do
+    Capistrano::Configuration.reset!.tap do |cfg|
+      cfg.set :application, "test-app"
+      cfg.set :stage, "test-stage"
+      cfg.set :notifier_mail_options, {
+        method:  :test,
+        from:    '"Deploy Notification" <deploy@example.com>',
+        to:      ['deploy+test-app@example.com'],
+        github:  'applicaster/test-app',
+      }
+    end
+  end
+
+  it "works" do
+    Rake::Task["deploy:notify:mail"].invoke
+    expect(ActionMailer::Base.deliveries.first.subject)
+      .to eq("test-app branch master deployed to test-stage")
+  end
+end

data/spec/integration/capistrano/notifier/statsd_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'capistrano/setup'
+require 'capistrano/deploy'
+require 'capistrano/notifier/statsd'
+
+describe "deploy:notify:statsd" do
+  before do
+    Capistrano::Configuration.reset!.tap do |cfg|
+      cfg.set :application, "test-app"
+      cfg.set :stage, "test-stage"
+      cfg.set :notifier_statsd_options, {
+        host: "10.0.0.1",
+        port: "8125"
+      }
+    end
+  end
+
+  it "works" do
+    Rake::Task["deploy:notify:statsd"].invoke
+  end
+end

data/spec/lib/capistrano/notifier/helpers/mail_spec.rb

@@ -0,0 +1,325 @@
+require 'spec_helper'
+require 'capistrano/notifier/helpers/mail'
+
+describe Capistrano::Notifier::Helpers::Mail do
+  let(:configuration) { Capistrano::Configuration.new }
+  let(:dummy_class) { configuration.extend(Capistrano::Notifier::Helpers::Mail) }
+
+  before do
+    dummy_class.set(:notifier_mail_options, {})
+  end
+
+  describe "#application" do
+    before { dummy_class.set(:application, "testapp") }
+
+    it "fetches :application from Capistrano configuration" do
+      expect(dummy_class.application).to eq("testapp")
+    end
+  end
+
+  describe "#branch" do
+    context "when :branch is set in Capistrano configuration" do
+      before { dummy_class.set(:branch, "dev") }
+
+      it "fetches :branch from Capistrano configuration" do
+        expect(dummy_class.branch).to eq("dev")
+      end
+    end
+
+    context "when :branch is not set in Capistrano configuration" do
+      it "returns 'master'" do
+        expect(dummy_class.branch).to eq("master")
+      end
+    end
+  end
+
+  describe "#git_current_revision" do
+    before { dummy_class.set(:current_revision, "949af5c") }
+
+    it "fetches :current_revision from Capistrano configuration" do
+      expect(dummy_class.git_current_revision).to eq("949af5c")
+    end
+  end
+
+  describe "#git_previous_revision" do
+    before { dummy_class.set(:previous_revision, "949af5c") }
+
+    it "fetches :previous_revision from Capistrano configuration" do
+      expect(dummy_class.git_previous_revision).to eq("949af5c")
+    end
+  end
+
+  describe "#git_range" do
+    context "when :current_revision and :previous_revision are set" do
+      before do
+        dummy_class.set(:current_revision, "949af5c")
+        dummy_class.set(:previous_revision, "0469d2d")
+      end
+
+      it "returns revisions range in git log format" do
+        expect(dummy_class.git_range).to eq("0469d2d..949af5c")
+      end
+    end
+
+    context "when :current_revision and :previous_revision are empty" do
+      it { expect(dummy_class.git_range).to eq(nil) }
+    end
+  end
+
+  describe "#git_log_command" do
+    before do
+      dummy_class.set(:notifier_mail_options, { log_command: "my command" })
+    end
+
+    it "fetches :log_command from :notifier_mail_options in Capistrano configuration" do
+      expect(dummy_class.git_log_command).to eq("my command")
+    end
+  end
+
+  describe "#git_log" do
+    before { allow(dummy_class).to receive(:git_range) { "0469d2d..949af5c" } }
+
+    context "when #git_range returns nil" do
+      before { allow(dummy_class).to receive(:git_range) { nil } }
+
+      it { expect(dummy_class.git_log).to eq(nil) }
+    end
+
+    context "when :log_command is set" do
+      before do
+        dummy_class.set(:notifier_mail_options, { log_command: "my command" })
+      end
+
+      it "runs system call with custom command" do
+        expect(dummy_class).to receive(:system_call).with("my command")
+        dummy_class.git_log
+      end
+    end
+
+    context "when :log_command not set" do
+      before { allow(dummy_class).to receive(:git_log_command) { nil } }
+
+      it "runs system call with deafult command" do
+        expect(dummy_class)
+          .to receive(:system_call)
+          .with('git log #{git_range} --no-merges --format=format:"%h %s (%an)"')
+
+        dummy_class.git_log
+      end
+    end
+  end
+
+  describe "#now" do
+    it "returns instance of Time.now" do
+      expect(Time).to receive(:now)
+      dummy_class.now
+    end
+  end
+
+  describe "#stage" do
+    before { dummy_class.set(:stage, "test") }
+
+    it "fetches :stage from Capistrano configuration" do
+      expect(dummy_class.stage).to eq("test")
+    end
+  end
+
+  describe "#user_name" do
+    context "when ENV['DEPLOYER'] is set" do
+      before do
+        allow(ENV).to receive(:[]).with("DEPLOYER") { "me" }
+      end
+
+       it { expect(dummy_class.user_name).to eq("me") }
+    end
+
+    context "when ENV['DEPLOYER'] not set" do
+      it "runs 'git config --get user.name'" do
+        expect(dummy_class)
+          .to receive(:system_call).with("git config --get user.name")
+          .and_return("")
+        dummy_class.user_name
+      end
+    end
+  end
+
+  describe "#notifier_mail_options" do
+    it "fetches :notifier_mail_options from Capistrano configuration" do
+      expect(dummy_class.notifier_mail_options).to eq({})
+    end
+  end
+
+  describe "#email_format" do
+    it "deafults to :text" do
+      expect(dummy_class.email_format).to eq(:text)
+    end
+
+    context "when set in :notifier_mail_options" do
+      before { dummy_class.set(:notifier_mail_options, { format: :plain }) }
+
+      it "works" do
+        expect(dummy_class.email_format).to eq(:plain)
+      end
+    end
+  end
+
+  describe "#email_template" do
+    it "deafults to 'mail.text.erb'" do
+      expect(dummy_class.email_template).to eq("mail.text.erb")
+    end
+
+    context "when set in :notifier_mail_options" do
+      before { dummy_class.set(:notifier_mail_options, { template: "mail.erb" }) }
+
+      it "works" do
+        expect(dummy_class.email_template).to eq("mail.erb")
+      end
+    end
+  end
+
+  describe "#email_from" do
+    before { dummy_class.set(:notifier_mail_options, { from: "test" }) }
+
+    it "works" do
+      expect(dummy_class.email_from).to eq("test")
+    end
+  end
+
+  describe "#github" do
+    before { dummy_class.set(:notifier_mail_options, { github: "test" }) }
+
+    it "works" do
+      expect(dummy_class.github).to eq("test")
+    end
+  end
+
+  describe "#giturl" do
+    before { dummy_class.set(:notifier_mail_options, { giturl: "test" }) }
+
+    it "works" do
+      expect(dummy_class.giturl).to eq("test")
+    end
+  end
+
+  describe "#git_prefix" do
+    before do
+      allow(dummy_class).to receive(:giturl) { "http://giturl" }
+    end
+
+    it "deafults to #giturl" do
+      expect(dummy_class.git_prefix).to eq("http://giturl")
+    end
+
+    context "when :notifier_mail_options not set" do
+      before do
+        allow(dummy_class).to receive(:giturl)
+      end
+
+      it "works" do
+        expect(dummy_class.git_prefix).to eq("https://github.com/")
+      end
+    end
+  end
+
+  describe "#git_commit_prefix" do
+    before do
+      allow(dummy_class).to receive(:git_prefix)
+    end
+
+    it "works" do
+      expect(dummy_class.git_commit_prefix).to eq("/commit")
+    end
+  end
+
+  describe "#git_compare_prefix" do
+    before do
+      allow(dummy_class).to receive(:git_prefix)
+    end
+
+    it "works" do
+      expect(dummy_class.git_compare_prefix).to eq("/compare")
+    end
+  end
+
+  describe "#delivery_method" do
+    before { dummy_class.set(:notifier_mail_options, { method: "test" }) }
+
+    it "works" do
+      expect(dummy_class.delivery_method).to eq("test")
+    end
+  end
+
+  describe "#notifier_smtp_settings" do
+    before { dummy_class.set(:notifier_mail_options, { smtp_settings: "test" }) }
+
+    it "works" do
+      expect(dummy_class.notifier_smtp_settings).to eq("test")
+    end
+  end
+
+  describe "#email_text" do
+    let(:templates_path) do
+      File.expand_path(File.join(__FILE__, '..','..','..','..','..','fixtures','templates'))
+    end
+
+    before do
+      allow(dummy_class).to receive(:templates_path) { templates_path }
+      allow(dummy_class).to receive(:application) { "testapp" }
+      allow(dummy_class).to receive(:github) { "applicaster/capistrano3-notifier" }
+      allow(dummy_class).to receive(:github_range) { "0469d2d...949af5c" }
+    end
+
+    it "renders email template" do
+      expect(dummy_class.email_text).to eq(
+        "Application:  testapp\n\nCompare:\n"\
+        "https://github.com/applicaster/capistrano3-notifier/compare/0469d2d...949af5c\n"
+      )
+    end
+  end
+
+  describe "#email_subject" do
+    before do
+      allow(dummy_class).to receive(:application) { "testapp" }
+      allow(dummy_class).to receive(:branch) { "testbranch" }
+      allow(dummy_class).to receive(:stage) { "teststage" }
+    end
+
+    it "defaults to '#application branch #branch deployed to #stage'" do
+      expect(dummy_class.email_subject).to eq("testapp branch testbranch deployed to teststage")
+    end
+
+    it "can be set via :notifier_mail_options" do
+      dummy_class.set(:notifier_mail_options, { subject: "test subject" })
+      expect(dummy_class.email_subject).to eq("test subject")
+    end
+  end
+
+  describe "#templates_path" do
+    it "defaults to 'config/deploy/templates'" do
+      expect(dummy_class.templates_path).to eq("config/deploy/templates")
+    end
+
+    it "can be set via :notifier_mail_options" do
+      dummy_class.set(:notifier_mail_options, { templates_path: "templates" })
+      expect(dummy_class.templates_path).to eq("templates")
+    end
+  end
+
+  describe "#email_to" do
+    before { dummy_class.set(:notifier_mail_options, { to: "test" }) }
+
+    it "works" do
+      expect(dummy_class.email_to).to eq("test")
+    end
+  end
+
+  describe "#content_type_for_format" do
+    it "defaults to 'text/plain'" do
+      expect(dummy_class.content_type_for_format).to eq("text/plain")
+    end
+
+    it "returns 'text/html' if :html is passed as option" do
+      expect(dummy_class.content_type_for_format(:html)).to eq("text/html")
+    end
+  end
+end

data/spec/lib/capistrano/notifier/helpers/statsd_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'capistrano/notifier/helpers/statsd'
+
+describe Capistrano::Notifier::Helpers::StatsD do
+  let(:configuration) { Capistrano::Configuration.new }
+  let(:dummy_class) { configuration.extend(Capistrano::Notifier::Helpers::StatsD) }
+
+  before do
+    dummy_class.set(:application, "test-app")
+    dummy_class.set(:stage, "test-stage")
+    dummy_class.set(:notifier_statsd_options, {})
+  end
+
+  describe "#statsd_notifier_command" do
+    it "works" do
+      expect(dummy_class.statsd_notifier_command)
+        .to eq("echo -n test-app.test-stage.deploy:1\\|c | nc -w 1 -u 127.0.0.1 8125")
+    end
+  end
+ end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'timecop'
+require 'capistrano/all'
+
+RSpec.configure do |config|
+  config.around :each do |example|
+    Timecop.freeze 2012, 1, 1 do
+      example.run
+    end
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: capistrano3-notifier
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Justin Campbell
+- Nathan L Smith
+- Vitaly Gorodetsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple notification hooks for Capistrano3
+email:
+- sysadmin@cramerdev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano3-notifier.gemspec
+- lib/capistrano/notifier/helpers/mail.rb
+- lib/capistrano/notifier/helpers/statsd.rb
+- lib/capistrano/notifier/mail.rb
+- lib/capistrano/notifier/statsd.rb
+- lib/capistrano/notifier/templates/mail.html.erb
+- lib/capistrano/notifier/templates/mail.text.erb
+- lib/capistrano/notifier/version.rb
+- lib/capistrano3-notifier.rb
+- spec/fixtures/templates/mail.text.erb
+- spec/integration/capistrano/notifier/mail_spec.rb
+- spec/integration/capistrano/notifier/statsd_spec.rb
+- spec/lib/capistrano/notifier/helpers/mail_spec.rb
+- spec/lib/capistrano/notifier/helpers/statsd_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cramerdev/capistrano-notifier
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Capistrano3 Notifier
+test_files:
+- spec/fixtures/templates/mail.text.erb
+- spec/integration/capistrano/notifier/mail_spec.rb
+- spec/integration/capistrano/notifier/statsd_spec.rb
+- spec/lib/capistrano/notifier/helpers/mail_spec.rb
+- spec/lib/capistrano/notifier/helpers/statsd_spec.rb
+- spec/spec_helper.rb