deployment_notifier 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jon Wood
+
+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.rdoc

@@ -0,0 +1,21 @@
+= deployment_notifier
+
+A plugin for Capistrano to send out notification e-mails on deployment.
+
+I'm aware of cap_gun, but that attempts to send the e-mails locally, which is
+no good in an environment where we don't have local SMTP servers.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jon Wood. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "deployment_notifier"
+    gem.summary = %Q{Deployment notifications for Capistrano}
+    gem.description = %Q{A plugin for Capistrano to send an e-mail to notify people about deployments.}
+    gem.email = "jon@blankpad.net"
+    gem.homepage = "http://github.com/jellybob/deployment_notifier"
+    gem.authors = ["Jon Wood"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+begin
+  require 'spec/rake/spectask'
+
+  desc "Run all specs"
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.libs = [ 'lib' ]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+  
+  desc "Run all specs, with coverage"
+  Spec::Rake::SpecTask.new('spec:coverage') do |t|
+    t.libs = [ 'lib' ]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec,osx\/objc,gems\/']
+  end
+rescue LoadError
+  puts "RSpec and RCov are required to run tests. Install it with: sudo gem install rspec rcov"
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "deployment_notifier #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/deployment_notifier.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{deployment_notifier}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jon Wood"]
+  s.date = %q{2009-10-05}
+  s.description = %q{A plugin for Capistrano to send an e-mail to notify people about deployments.}
+  s.email = %q{jon@blankpad.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "deployment_notifier.gemspec",
+     "lib/blankpad/deployment_notifier.rb",
+     "spec/blankpad/deployment_notifier_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jellybob/deployment_notifier}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Deployment notifications for Capistrano}
+  s.test_files = [
+    "spec/blankpad/deployment_notifier_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/blankpad/deployment_notifier.rb

@@ -0,0 +1,106 @@
+require 'etc'
+
+module Blankpad
+  # A Capistrano plugin to send deployment notifications
+  module DeploymentNotifier
+    VERSION = File.read(File.dirname(__FILE__) + "/../../VERSION").strip.split(".")
+
+    @@recipients = []
+    def self.recipients
+      @@recipients
+    end
+
+    def self.recipients=(recipients)
+      @@recipients = recipients
+    end
+    
+    @@from = ""
+    def self.from
+      @@from
+    end
+
+    def self.from=(from)
+      @@from = from
+    end
+    
+    def self.deployer
+      Etc.getlogin
+    end
+
+    # Responsible for taking the e-mail to send, and sending it using the remote
+    # server's sendmail command.
+    class Mailer
+      attr_reader :capistrano
+      
+      def initialize(capistrano)
+        @capistrano = capistrano
+      end
+
+      # Delivers a notification e-mail
+      def deliver!
+        capistrano.run(delivery_command)
+      end
+      
+      # Constructs the final command which will be sent run on the server.
+      def delivery_command
+        "echo -en '#{message}' | #{mta_command}"
+      end
+
+      def mta_command
+        "/usr/sbin/sendmail #{DeploymentNotifier.recipients.join(" ")}"
+      end
+
+      def message
+        Message.new(capistrano, Blankpad::DeploymentNotifier.deployer).to_s.gsub(/\n/, "\\n")
+      end
+    end
+
+    class Message
+      attr_reader :capistrano
+      
+      def initialize(capistrano, deployer)
+        @capistrano = capistrano
+        @deployer = deployer
+      end
+      
+      def headers
+        {
+          "Subject"  => "[DEPLOY] #{capistrano[:application]} #{capistrano[:stage]}",
+          "From"     => DeploymentNotifier.from,
+          "To"       => DeploymentNotifier.recipients.join(", "),
+          "X-Mailer" => "DeploymentNotifier"
+        }
+      end
+
+      def body
+        body = <<EOM
+#{@deployer} has deployed revision #{capistrano[:current_revision]} of #{capistrano[:application]} to #{capistrano[:stage]}
+
+Application: #{capistrano[:application]}
+Stage: #{capistrano[:stage]}
+Repository: #{capistrano[:repository]}
+Current Revision: #{capistrano[:current_revision]}
+Previous revision: #{capistrano[:previous_revision]}
+EOM
+        body = capistrano[:message] + "\n\n#{body}" if capistrano[:message]
+
+        body
+      end
+
+      def to_s
+        headers.collect { |key, value| "#{key}: #{value}" }.join("\n") << "\n\n#{body}"
+      end
+    end
+  end
+end
+
+if Object.const_defined?("Capistrano")
+  Capistrano::Configuration.instance(:must_exist).load do
+    namespace "deploy" do
+      desc "Send a notification e-mail to people who want one"
+      task :notify do
+        Blankpad::DeploymentNotifier::Mailer.new(self).deliver!
+      end
+    end
+  end
+end

data/spec/blankpad/deployment_notifier_spec.rb

@@ -0,0 +1,209 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Blankpad::DeploymentNotifier do
+  describe "the version number" do
+    it "should not be nil" do
+      Blankpad::DeploymentNotifier::VERSION.should_not be_nil
+    end
+    
+    it "should be a three element array" do
+      Blankpad::DeploymentNotifier::VERSION.should have(3).items
+    end
+
+    it "should be the same as the contents of VERSION" do
+      expected_version = File.read(File.dirname(__FILE__) + "/../../VERSION").strip.split(".")
+      Blankpad::DeploymentNotifier::VERSION.should eql(expected_version)
+    end
+  end
+  
+  describe "configuration" do
+    it "should allow the recipients list to be set and retriveed" do
+      Blankpad::DeploymentNotifier.should respond_to(:recipients)
+      Blankpad::DeploymentNotifier.should respond_to(:recipients=)
+    end
+
+    it "should return the same set of recipients" do
+      recipients = [ "one@example.org" ]
+      
+      Blankpad::DeploymentNotifier.recipients = recipients
+      Blankpad::DeploymentNotifier.recipients.should eql(recipients)
+    end
+
+    it "should allow the from address to be set and retrieved" do
+      from = "Example Deployer <deploy@example.org>"
+
+      Blankpad::DeploymentNotifier.from = from
+      Blankpad::DeploymentNotifier.from.should eql(from)
+    end
+
+    it "should allow the person deploying to be retrieved" do
+      Etc.stub!(:getlogin).and_return("jon")
+      Blankpad::DeploymentNotifier.deployer.should eql("jon")
+    end
+  end
+
+  describe "the mailer" do
+    before(:each) do
+      @capistrano = mock("Capistrano")
+      @mailer = Blankpad::DeploymentNotifier::Mailer.new(@capistrano)
+    end
+    
+    it "should provide a way of accessing the Capistrano instance" do
+      @mailer.should respond_to(:capistrano)
+    end
+
+    it "should use the first argument as a Cap instance" do
+      @mailer.capistrano.should eql(@capistrano)
+    end
+    
+    describe "mail delivery" do
+      it "provide a method to deliver notification e-mails" do
+        @mailer.should respond_to(:deliver!)
+      end
+
+      it "should have a method which builds the delivery command" do
+        @mailer.should respond_to(:delivery_command)
+      end
+      
+      it "should run the delivery command with deliver! is called, and pass the result to run" do
+        @mailer.should_receive(:delivery_command).and_return("")
+        @capistrano.should_receive(:run).with("")
+        
+        @mailer.deliver!
+      end
+
+      describe "the delivery command" do
+        it "should be made up of a message, which is piped to the MTA" do
+          @mailer.should_receive(:message).and_return("The message")
+          @mailer.should_receive(:mta_command).and_return("/usr/sbin/sendmail null@example.org")
+
+          @mailer.delivery_command.should eql("echo -en 'The message' | /usr/sbin/sendmail null@example.org")
+        end
+      end
+
+      it "should have a method to retrieve the MTA command" do
+        @mailer.should respond_to(:mta_command)
+      end
+
+      describe "the mta command" do
+        it "should be sendmail, followed by a space seperated list of recipients" do
+          Blankpad::DeploymentNotifier.recipients = %w[one@example.org two@example.org]
+          
+          @mailer.mta_command.should eql('/usr/sbin/sendmail one@example.org two@example.org')
+        end
+      end
+
+      it "should have a method to retrieve the message to send" do
+        @mailer.should respond_to(:message)
+      end
+
+      describe "the message method" do
+        it "should create a new Message object, and return it's string representation" do
+          message = mock("a message")
+          message.should_receive(:to_s).and_return("the message to send")
+
+          Blankpad::DeploymentNotifier::Message.stub!(:new).and_return(message)
+          @mailer.message
+        end
+
+        it "should escape any newline characters" do
+          message = mock("a message")
+          message.should_receive(:to_s).and_return("the message to send\n")
+
+          Blankpad::DeploymentNotifier::Message.stub!(:new).and_return(message)
+          @mailer.message.should match(/\\n/)
+        end
+      end
+    end
+  end
+
+  describe "a message" do
+    before(:each) do
+      @capistrano = stub("Capistrano")
+      @message = Blankpad::DeploymentNotifier::Message.new(@capistrano, "deployer")
+    end
+    
+    def add_property(name, value)
+      @capistrano.stub!(:[]).with(name).and_return(value)
+    end
+
+    it "should have a method to retreive the headers" do
+      @message.should respond_to(:headers)
+    end
+
+    describe "the message headers" do
+      before(:each) do
+        add_property(:application, "application_name")
+        add_property(:stage, "stage")
+      end
+
+      it "should set the subject to '[DEPLOY] application_name stage' by default" do
+        @message.headers["Subject"].should eql("[DEPLOY] application_name stage")
+      end
+
+      it "should set the from address to the one configured" do
+        Blankpad::DeploymentNotifier.from = "Deployment Notifier <deploy@example.org>"
+
+        @message.headers["From"].should eql("Deployment Notifier <deploy@example.org>")
+      end
+
+      it "should set the mailer to 'DeploymentNotifier'" do
+        @message.headers["X-Mailer"].should eql("DeploymentNotifier")
+      end
+
+      it "should set the to address to the recipients" do
+        Blankpad::DeploymentNotifier.recipients = ["One <one@example.org>", "Two <two@example.org>"]
+        @message.headers["To"].should eql("One <one@example.org>, Two <two@example.org>")
+      end
+    end
+    
+    it "should have a method to retrieve the message body" do
+      @message.should respond_to(:body)
+    end
+
+    describe "the message body" do
+      properties = {
+        :application        => "application_name",
+        :stage              => "stage",
+        :repository         => "git://github.com/example/example_org.git",
+        :current_revision   => "f8ds98f0sd8f0sd8",
+        :previous_revision  => "f9s8fsd8f0sd0sdf"
+      }
+      
+      before(:each) do
+        @capistrano.stub!(:[]).and_return(nil) 
+        properties.each do |name, value|
+          add_property(name, value)
+        end
+        
+        Etc.stub!(:getlogin).and_return("deployer")
+      end
+            
+      it "should include a summary" do
+        @message.body.should match(/deployer has deployed revision f8ds98f0sd8f0sd8 of application_name to stage/i)
+      end
+
+      properties.each do |name, value|
+        it "should include the #{name} property" do
+          @message.body.should match(/#{name.to_s.gsub("_", " ")}: #{value}/i)
+        end
+      end
+
+      it "should include the explanation when a message has been set" do
+        add_property :message, "Because I feel like it."
+
+        @message.body.should match(/Because I feel like it./)
+      end
+    end
+
+    it "should return the full message with headers on to_s" do
+      @message.stub!(:headers).and_return({"One" => "Header 1", "Two" => "Header 2"})
+      @message.stub!(:body).and_return("The body")
+
+      @message.to_s.should eql(%Q{One: Header 1
+Two: Header 2
+
+The body})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'blankpad/deployment_notifier'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: deployment_notifier
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jon Wood
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A plugin for Capistrano to send an e-mail to notify people about deployments.
+email: jon@blankpad.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- deployment_notifier.gemspec
+- lib/blankpad/deployment_notifier.rb
+- spec/blankpad/deployment_notifier_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jellybob/deployment_notifier
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Deployment notifications for Capistrano
+test_files: 
+- spec/blankpad/deployment_notifier_spec.rb
+- spec/spec_helper.rb