capistrano-notifier 0.0.2 → 0.1.0

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - ree
+notifications:
+  email:
+    - sysadmin@cramerdev.com
+

data/Gemfile

@@ -3,6 +3,8 @@ source :rubygems
 gemspec
 
 group :development, :test do
+  gem 'rake'
+
   group :darwin do
     gem 'rb-fsevent'
     gem 'growl'

data/Guardfile

@@ -1,6 +1,6 @@
 guard 'rspec', :version => 2 do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
 

data/README.md

@@ -1,4 +1,5 @@
-# CapistranoNotifier
+# Capistrano Notifier [![Build Status](https://secure.travis-ci.org/cramerdev/capistrano-notifier.png)](https://secure.travis-ci.org/cramerdev/capistrano-notifier)
+
 
 ## Install
 
@@ -10,29 +11,51 @@ gem 'capistrano-notifier'
 
 and then `bundle install`
 
-## Configure
+`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'
+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'],
+  :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`.
 
-set :notify_method, :test # :smtp, :sendmail, or any other valid ActionMailer delivery method
-set :notify_from, "capistrano@domain.com"
-set :notify_to, ["john@doe.com", "jane@doe.com"]
-set :notify_github_project, "MyCompany/project-name"
 
-namespace :deploy do
-  desc "Capistrano Notifier"
-  task :notify do
-    Capistrano::Notifier.new(self).perform
-  end
-end
+## StatsD
 
-after 'deploy', 'deploy:notify'
+```rb
+require 'capistrano/notifier/statsd'
 ```
 
-## Test
+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`:
 
-```sh
-cap deploy:notify
+```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"
+}
+```

data/capistrano-notifier.gemspec

@@ -1,23 +1,25 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/capistrano_notifier/version', __FILE__)
+require File.expand_path('../lib/capistrano/notifier/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Justin Campbell"]
-  gem.email         = ["justin@justincampbell.me"]
+  gem.authors       = ["Justin Campbell", "Nathan L Smith"]
+  gem.email         = ["sysadmin@cramerdev.com"]
   gem.description   = %q{Capistrano Notifier}
   gem.summary       = %q{Capistrano Notifier}
-  gem.homepage      = "http://github.com/CramerDev/capistrano-notifier"
+  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          = "capistrano-notifier"
   gem.require_paths = ["lib"]
-  gem.version       = CapistranoNotifier::VERSION
+  gem.version       = Capistrano::Notifier::VERSION
 
   gem.add_dependency 'actionmailer'
   gem.add_dependency 'activesupport'
+  gem.add_dependency 'capistrano', '>= 2'
 
   gem.add_development_dependency 'guard-rspec'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'timecop'
 end

data/lib/capistrano/notifier.rb

@@ -0,0 +1,11 @@
+module Capistrano
+  module Notifier
+  end
+end
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'capistrano'
+
+require 'capistrano/notifier/base'
+

data/lib/capistrano/notifier/base.rb

@@ -0,0 +1,56 @@
+class Capistrano::Notifier::Base
+  def initialize(capistrano)
+    @cap = capistrano
+  end
+
+  private
+
+  def application
+    cap.application
+  end
+
+  def branch
+    cap.branch
+  end
+
+  def cap
+    @cap
+  end
+
+  def git_current_revision
+    cap.current_revision[0,7]
+  end
+
+  def git_log
+    `git log #{git_range} --no-merges --format=format:"%h %s (%an)"`
+  end
+
+  def git_previous_revision
+    cap.previous_revision[0,7]
+  end
+
+  def git_range
+    "#{git_previous_revision}..#{git_current_revision}"
+  end
+
+  def now
+    @now ||= Time.now
+  end
+
+  def stage
+    cap.stage if cap.respond_to? :stage
+  end
+
+  def user_name
+    user = ENV['DEPLOYER']
+    user = `git config --get user.name`.strip if user.nil?
+  end
+end
+
+# Band-aid for issue with Capistrano
+# https://github.com/capistrano/capistrano/issues/168#issuecomment-4144687
+Capistrano::Configuration::Namespaces::Namespace.class_eval do
+  def capture(*args)
+    parent.capture *args
+  end
+end

data/lib/capistrano/notifier/mail.rb

@@ -0,0 +1,97 @@
+require 'capistrano/notifier'
+require 'action_mailer'
+
+class Capistrano::Notifier::Mail < Capistrano::Notifier::Base
+  def self.load_into(configuration)
+    configuration.load do
+      namespace :deploy do
+        namespace :notify do
+          desc 'Send a deployment notification via email.'
+          task :mail do
+            Capistrano::Notifier::Mail.new(configuration).perform
+          end
+        end
+      end
+
+      after 'deploy', 'deploy:notify:mail'
+    end
+  end
+
+  def perform
+    mail = ActionMailer::Base.mail({
+      :body => text,
+      :delivery_method => notify_method,
+      :from => from,
+      :subject => subject,
+      :to => to
+    })
+
+    mail.deliver
+
+    puts ActionMailer::Base.deliveries if notify_method == :test
+  end
+
+  private
+
+  def body
+    <<-BODY.gsub(/^ {6}/, '')
+      #{user_name} deployed
+      #{application.titleize} branch
+      #{branch} to
+      #{stage} on
+      #{now.strftime("%m/%d/%Y")} at
+      #{now.strftime("%I:%M %p %Z")}
+
+      #{git_range}
+      #{git_log}
+    BODY
+  end
+
+  def from
+    cap.notifier_mail_options[:from]
+  end
+
+  def github_commit_prefix
+    "#{github_prefix}/commit"
+  end
+
+  def github_compare_prefix
+    "#{github_prefix}/compare"
+  end
+
+  def github_prefix
+    "https://github.com/#{github}"
+  end
+
+  def github
+    cap.notifier_mail_options[:github]
+  end
+
+  def html
+    body.gsub(
+      /([0-9a-f]{7})\.\.([0-9a-f]{7})/, "<a href=\"#{github_compare_prefix}/\\1...\\2\">\\1..\\2</a>"
+    ).gsub(
+      /^([0-9a-f]{7})/, "<a href=\"#{github_commit_prefix}/\\0\">\\0</a>"
+    )
+  end
+
+  def notify_method
+    cap.notifier_mail_options[:method]
+  end
+
+  def subject
+    "#{application.titleize} branch #{branch} deployed to #{stage}"
+  end
+
+  def text
+    body.gsub(/([0-9a-f]{7})\.\.([0-9a-f]{7})/, "#{github_compare_prefix}/\\1...\\2")
+  end
+
+  def to
+    cap.notifier_mail_options[:to]
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Notifier::Mail.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/notifier/statsd.rb

@@ -0,0 +1,66 @@
+require 'capistrano/notifier'
+require 'socket'
+
+class Capistrano::Notifier::StatsD < Capistrano::Notifier::Base
+  DEFAULTS = { :host => "127.0.0.1", :port => "8125", :with => :counter }
+
+  def self.load_into(configuration)
+    configuration.load do
+      namespace :deploy do
+        namespace :notify do
+          desc 'Notify StatsD of deploy.'
+          task :statsd do
+            Capistrano::Notifier::StatsD.new(configuration).perform
+          end
+        end
+      end
+
+      after 'deploy', 'deploy:notify:statsd'
+    end
+  end
+
+  def perform
+    socket.send packet, 0, host, port
+  end
+
+  private
+
+  def host
+    options[:host]
+  end
+
+  def options
+    if cap.respond_to? :notifier_statsd_options
+      cap.notifier_statsd_options.reverse_merge DEFAULTS
+    else
+      DEFAULTS
+    end
+  end
+
+  def packet
+    if stage
+      "#{application}.#{stage}.deploy:#{with}"
+    else
+      "#{application}.deploy:#{with}"
+    end
+  end
+
+  def port
+    options[:port]
+  end
+
+  def socket
+    @socket ||= UDPSocket.new
+  end
+
+  def with
+    case options[:with]
+    when :counter then "1|c"
+    when :gauge   then "1|g"
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Notifier::StatsD.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/notifier/version.rb

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

data/spec/capistrano/notifier/mail_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'capistrano/notifier/mail'
+
+describe Capistrano::Notifier::Mail do
+  let(:configuration) { Capistrano::Configuration.new }
+  subject { described_class.new configuration }
+
+  before :each do
+    configuration.load do |configuration|
+      set :notifier_mail_options, {
+        :github => 'example/example',
+        :method => :sendmail,
+        :from   => 'sender@example.com',
+        :to     => 'example@example.com'
+      }
+
+      set :application, 'example'
+      set :branch,      'master'
+      set :stage,       'test'
+
+      set :current_revision,  '12345670000000000000000000000000'
+      set :previous_revision, '890abcd0000000000000000000000000'
+    end
+
+    subject.stub(:git_log).and_return <<-LOG.gsub /^ {6}/, ''
+      1234567 This is the current commit (John Doe)
+      890abcd This is the previous commit (John Doe)
+    LOG
+    subject.stub(:user_name).and_return "John Doe"
+  end
+
+  it { subject.send(:github).should         == 'example/example' }
+  it { subject.send(:notify_method).should  == :sendmail }
+  it { subject.send(:from).should           == 'sender@example.com' }
+  it { subject.send(:to).should             == 'example@example.com' }
+
+  it "creates a subject" do
+    subject.send(:subject).should == "Example branch master deployed to test"
+  end
+
+  it "renders a plaintext email" do
+    subject.send(:body).should == <<-BODY.gsub(/^ {6}/, '')
+      John Doe deployed
+      Example branch
+      master to
+      test on
+      01/01/2012 at
+      12:00 AM #{Time.now.zone}
+
+      890abcd..1234567
+      1234567 This is the current commit (John Doe)
+      890abcd This is the previous commit (John Doe)
+
+    BODY
+  end
+end

data/spec/capistrano/notifier/statsd_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'capistrano/notifier/statsd'
+
+describe Capistrano::Notifier::StatsD do
+  let(:configuration) { Capistrano::Configuration.new }
+  subject { described_class.new configuration }
+
+  before :each do
+    configuration.load do |configuration|
+      set :application, 'example'
+    end
+  end
+
+  it "sets defaults" do
+    subject.send(:host).should == '127.0.0.1'
+    subject.send(:port).should == '8125'
+    subject.send(:with).should == '1|c'
+  end
+
+  it "creates a packet" do
+    subject.send(:packet).should == "example.deploy:1|c"
+  end
+
+  it "sends a packet" do
+    UDPSocket.any_instance.should_receive(:send).once.with(
+      "example.deploy:1|c", 0, "127.0.0.1", "8125"
+    )
+
+    subject.perform
+  end
+
+  context "with a stage" do
+    before :each do
+      configuration.load do |configuration|
+        set :application, 'example'
+        set :stage,       'test'
+      end
+    end
+
+    it "creates a packet" do
+      subject.send(:packet).should == "example.test.deploy:1|c"
+    end
+  end
+
+  context "with statsd options" do
+    before :each do
+      configuration.load do |configuration|
+        set :notifier_statsd_options, {
+          :host => '10.0.0.1',
+          :port => '1234'
+        }
+
+        set :application, 'example'
+      end
+    end
+
+    it "uses the options" do
+      subject.send(:host).should == '10.0.0.1'
+      subject.send(:port).should == '1234'
+    end
+  end
+
+  context "with a gauge" do
+    before :each do
+      configuration.load do |configuration|
+        set :notifier_statsd_options, {
+          :with => :gauge
+        }
+
+        set :application, 'example'
+      end
+    end
+
+    it { subject.send(:with).should == "1|g" }
+  end
+
+  context "with an uppercase application" do
+    before :each do
+      configuration.load do
+        set :application, 'Example'
+      end
+
+      it "lowercases the application" do
+        subject.send(:packet).should == "example.deploy:1|c"
+      end
+    end
+  end
+end

data/spec/capistrano/notifier_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+require 'capistrano/notifier'
+
+describe Capistrano::Notifier do
+  it { described_class.should be_a Module }
+end

data/spec/spec_helper.rb

@@ -1,2 +1,9 @@
-require "capistrano-notifier"
+require 'timecop'
 
+RSpec.configure do |config|
+  config.around :each do |example|
+    Timecop.freeze 2012, 1, 1 do
+      example.run
+    end
+  end
+end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-notifier
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
 - Justin Campbell
+- Nathan L Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &70218232046560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +22,47 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70218232046560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70218232045940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70218232045940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70218232044940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +70,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70218232044940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70218232044360 !ruby/object:Gem::Requirement
+  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: timecop
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +102,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70218232044360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Capistrano Notifier
 email:
-- justin@justincampbell.me
+- sysadmin@cramerdev.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -65,18 +118,27 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - capistrano-notifier.gemspec
-- lib/capistrano-notifier.rb
-- lib/capistrano_notifier.rb
-- lib/capistrano_notifier/version.rb
-- spec/capistrano_notifier_spec.rb
+- lib/capistrano/notifier.rb
+- lib/capistrano/notifier/base.rb
+- lib/capistrano/notifier/mail.rb
+- lib/capistrano/notifier/statsd.rb
+- lib/capistrano/notifier/templates/mail.erb
+- lib/capistrano/notifier/templates/mail.html.erb
+- lib/capistrano/notifier/templates/mail.text.erb
+- lib/capistrano/notifier/templates/mail.txt.erb
+- lib/capistrano/notifier/version.rb
+- spec/capistrano/notifier/mail_spec.rb
+- spec/capistrano/notifier/statsd_spec.rb
+- spec/capistrano/notifier_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/CramerDev/capistrano-notifier
+homepage: http://github.com/cramerdev/capistrano-notifier
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -96,10 +158,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Capistrano Notifier
 test_files:
-- spec/capistrano_notifier_spec.rb
+- spec/capistrano/notifier/mail_spec.rb
+- spec/capistrano/notifier/statsd_spec.rb
+- spec/capistrano/notifier_spec.rb
 - spec/spec_helper.rb

data/lib/capistrano-notifier.rb

@@ -1 +0,0 @@
-require 'capistrano_notifier'

data/lib/capistrano_notifier.rb

@@ -1,133 +0,0 @@
-require "action_mailer"
-require "active_support"
-require "capistrano_notifier/version"
-
-Capistrano::Configuration::Namespaces::Namespace.class_eval do
-  def capture(*args)
-    parent.capture *args
-  end
-end
-
-module Capistrano
-  class Notifier
-    def initialize(capistrano)
-      @cap = capistrano
-    end
-
-    def perform
-      mail = ActionMailer::Base.mail({
-        :body => text,
-        :delivery_method => notify_method,
-        :from => from,
-        :subject => subject,
-        :to => to
-      })
-
-      mail.deliver
-
-      puts ActionMailer::Base.deliveries if notify_method == :test
-    end
-
-    private
-
-    def application
-      cap.application.titleize
-    end
-
-    def body
-<<-BODY
-#{user} deployed
-#{application} branch
-#{branch} to
-#{stage} on
-#{now.strftime("%m/%d/%Y")} at
-#{now.strftime("%I:%M %p %Z")}
-
-#{git_range}
-#{git_log}
-BODY
-    end
-
-    def branch
-      cap.branch
-    end
-
-    def cap
-      @cap
-    end
-
-    def current_revision
-      cap.current_revision[0,7]
-    end
-
-    def from
-      cap.notify_from
-    end
-
-    def git_log
-      `git log #{git_range} --no-merges --format=format:"%h %s (%an)"`
-    end
-
-    def git_range
-      "#{previous_revision}..#{current_revision}"
-    end
-
-    def github_commit_prefix
-      "#{github_prefix}/commit"
-    end
-
-    def github_compare_prefix
-      "#{github_prefix}/compare"
-    end
-
-    def github_prefix
-      "https://github.com/#{github_project}"
-    end
-
-    def github_project
-      cap.notify_github_project
-    end
-
-    def html
-      body.gsub(
-        /([0-9a-f]{7})\.\.([0-9a-f]{7})/, "<a href=\"#{github_compare_prefix}/\\1...\\2\">\\1..\\2</a>"
-      ).gsub(
-        /^([0-9a-f]{7})/, "<a href=\"#{github_commit_prefix}/\\0\">\\0</a>"
-      )
-    end
-
-    def previous_revision
-      cap.previous_revision[0,7]
-    end
-
-    def notify_method
-      cap.notify_method
-    end
-
-    def now
-      @now ||= Time.new
-    end
-
-    def stage
-      cap.stage
-    end
-
-    def subject
-      "#{user} deployed #{application}@#{branch} to #{stage}"
-    end
-
-    def text
-      body.gsub(/([0-9a-f]{7})\.\.([0-9a-f]{7})/, "#{github_compare_prefix}/\\1...\\2")
-    end
-
-    def to
-      cap.notify_to
-    end
-
-    def user
-      user = ENV['DEPLOYER']
-      user = `git config --get user.name`.strip if user.nil?
-    end
-  end
-end
-

data/lib/capistrano_notifier/version.rb

@@ -1,3 +0,0 @@
-module CapistranoNotifier
-  VERSION = "0.0.2"
-end

data/spec/capistrano_notifier_spec.rb

@@ -1,5 +0,0 @@
-require "spec_helper"
-
-describe Capistrano::Notifier do
-  it { described_class.should be_a Class }
-end