cap_gun 0.0.2 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.0.5. Fix subject line iv there is no rails_env defined
+
+v0.0.4. Add dev dependency on echoe; update manifest
+
+v0.0.3. Don't try to convert the RAILS_ENV if its not set to better support default capistrano deployments
+
 v0.0.2. Converts the release times to the current time zone; improved docs.
 
 v0.0.1. Initial release.  Rock n roll mcdonalds.

data/README.rdoc

@@ -37,7 +37,7 @@ In your Capistrano config file (usually deploy.rb):
 == REQUIREMENTS
 
 * Capistrano 2+
-* A Gmail account to send from, or an MTA installed locally to send from
+* A Gmail account to send from, or an MTA (mail transport agent) installed locally to send from
 * Something to deploy
 
 == TODO & KNOWN ISSUES
@@ -55,7 +55,7 @@ In your Capistrano config file (usually deploy.rb):
 
 * Log bugs, issues, and suggestions on Trac: http://opensource.thinkrelevance.com/wiki/cap_gun
 * View source: http://github.com/relevance/cap_gun/tree/master
-* Git clone source: git://github.com/relevance/cap_gun.git
+* Git: git clone git://github.com/relevance/cap_gun.git
 * RDocs: http://thinkrelevance.rubyforge.org/cap_gun/
 
 == LICENSE

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  gem 'technicalpickles-echoe'
+rescue LoadError => e
+  puts "couldn't find the correct version of echoe - please install from forked version on github: http://github.com/technicalpickles/echoe/"
+  puts "gem sources -a http://gems.github.com"
+  puts "sudo gem install technicalpickles-echoe"
+end
+  
+require 'rubygems'
+require 'echoe'
+require './lib/cap_gun.rb'
+
+echoe = Echoe.new('cap_gun') do |p|
+  p.rubyforge_name = 'thinkrelevance'
+  p.author = ["Rob Sanheim", "Relevance"]
+  p.email = 'opensource@thinkrelevance.com'
+  p.version = CapGun::VERSION
+  p.summary = "Bang! You're deployed!"
+  p.description = 'Super simple capistrano deployments.'
+  p.url = "http://opensource.thinkrelevance.com/wiki/cap_gun"
+  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc|CHANGELOG|MIT-LICENSE$/
+  rdoc_template = `allison --path`.strip << ".rb"
+  p.rdoc_template = rdoc_template
+  p.test_pattern = 'spec/**/*_spec.rb'
+  p.manifest_name = 'manifest.txt'
+end
+
+echoe.spec.add_development_dependency "echoe"

data/cap_gun.gemspec

@@ -1,48 +1,36 @@
-
-# Gem::Specification for Cap_gun-0.0.2
-# Originally generated by Echoe
-
 Gem::Specification.new do |s|
   s.name = %q{cap_gun}
-  s.version = "0.0.2"
-
-  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.version = "0.0.5"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim, Relevance"]
-  s.date = %q{2008-04-20}
+  s.date = %q{2008-07-04}
   s.description = %q{Super simple capistrano deployments.}
   s.email = %q{opensource@thinkrelevance.com}
   s.extra_rdoc_files = ["CHANGELOG", "lib/cap_gun.rb", "MIT-LICENSE", "README.rdoc"]
-  s.files = ["CHANGELOG", "init.rb", "install.rb", "lib/cap_gun.rb", "manifest.txt", "MIT-LICENSE", "README.rdoc", "spec/cap_gun_spec.rb", "tasks/cap_bot_tasks.rake", "vendor/action_mailer_tls/init.rb", "vendor/action_mailer_tls/lib/smtp_tls.rb", "vendor/action_mailer_tls/README", "vendor/action_mailer_tls/sample/mailer.yml.sample", "vendor/action_mailer_tls/sample/smtp_gmail.rb", "cap_gun.gemspec"]
+  s.files = ["cap_gun.gemspec", "CHANGELOG", "init.rb", "install.rb", "lib/cap_gun.rb", "manifest.txt", "MIT-LICENSE", "Rakefile", "README.rdoc", "spec/cap_gun_spec.rb", "tasks/cap_bot_tasks.rake", "vendor/action_mailer_tls/init.rb", "vendor/action_mailer_tls/lib/smtp_tls.rb", "vendor/action_mailer_tls/README", "vendor/action_mailer_tls/sample/mailer.yml.sample", "vendor/action_mailer_tls/sample/smtp_gmail.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://opensource.thinkrelevance.com/wiki/cap_gun}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Cap_gun", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{thinkrelevance}
-  s.rubygems_version = %q{1.1.1}
+  s.rubygems_version = %q{1.2.0}
   s.summary = %q{Bang! You're deployed!}
   s.test_files = ["spec/cap_gun_spec.rb"]
-end
 
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
 
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# require 'rubygems'
-# require 'echoe'
-# require './lib/cap_gun.rb'
-# 
-# hoe = Echoe.new('cap_gun') do |p|
-#   p.rubyforge_name = 'thinkrelevance'
-#   p.author = ["Rob Sanheim", "Relevance"]
-#   p.email = 'opensource@thinkrelevance.com'
-#   p.version = CapGun::VERSION
-#   p.summary = "Bang! You're deployed!"
-#   p.description = 'Super simple capistrano deployments.'
-#   p.url = "http://opensource.thinkrelevance.com/wiki/cap_gun"
-#   p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc|CHANGELOG|MIT-LICENSE$/
-#   rdoc_template = `allison --path`.strip << ".rb"
-#   p.rdoc_template = rdoc_template
-#   p.test_pattern = 'spec/**/*_spec.rb'
-#   p.manifest_name = 'manifest.txt'
-# end
+    if current_version >= 3 then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/lib/cap_gun.rb

@@ -27,7 +27,7 @@ require File.join(File.dirname(__FILE__), *%w[.. vendor action_mailer_tls lib sm
 #
 # See README for full install/config instructions.
 module CapGun
-  VERSION = '0.0.2'
+  VERSION = '0.0.5'
 
   module Helper
     
@@ -53,6 +53,7 @@ module CapGun
     # This assumes Capistrano uses UTC for its date/timestamped directories, and converts to the local
     # machine timezone.
     def humanize_release_time(path)
+      return unless path
       match = path.match(/(\d+)$/)
       return unless match
       local = convert_from_utc(match[1])
@@ -83,11 +84,12 @@ module CapGun
   class Mailer < ActionMailer::Base
       include CapGun::Helper
       DEFAULT_SENDER = %("CapGun" <cap_gun@example.com>)
-      DEFAULT_EMAIL_PREFIX = "[DEPLOY] "
+      DEFAULT_EMAIL_PREFIX = "[DEPLOY]"
       
       adv_attr_accessor :email_prefix
+      attr_accessor :summary
       
-      # Grab the options for emaililng from cap_gun_email_envelope (should be set in your deploy file)
+      # Grab the options for emailing from cap_gun_email_envelope (should be set in your deploy file)
       #
       # Valid options:
       #     :recipients     (required) an array or string of email address(es) that should get notifications
@@ -102,16 +104,25 @@ module CapGun
       # Do the actual email
       def deployment_notification(capistrano)
         init(capistrano[:cap_gun_email_envelope])
+        self.summary = create_summary(capistrano)
         
         content_type "text/plain"
-        subject "#{email_prefix} #{capistrano[:application]} deployed to #{capistrano[:rails_env]}"
+        subject "#{email_prefix} #{capistrano[:application]} #{deployed_to(capistrano)}"
         body    create_body(capistrano)
       end
       
+      def create_summary(capistrano)
+        %[#{capistrano[:application]} was deployed#{" to " << capistrano[:rails_env] if capistrano[:rails_env]} by #{current_user} at #{humanize_release_time(capistrano[:current_release])}.]
+      end
+      
+      def deployed_to(capistrano)
+        returning(s = "deployed") { s += " to #{capistrano[:rails_env]}" if capistrano[:rails_env] }
+      end
+      
       # Create the body of the message using a bunch of values from Capistrano
       def create_body(capistrano)
 <<-EOL
-#{capistrano[:application]} was deployed to #{capistrano[:rails_env]} by #{current_user} at #{humanize_release_time(capistrano[:current_release])}.
+#{summary}
 
 Comment: #{capistrano[:comment] || "[none given]"}
 

data/manifest.txt

@@ -1,9 +1,11 @@
+cap_gun.gemspec
 CHANGELOG
 init.rb
 install.rb
 lib/cap_gun.rb
 manifest.txt
 MIT-LICENSE
+Rakefile
 README.rdoc
 spec/cap_gun_spec.rb
 tasks/cap_bot_tasks.rake

data/spec/cap_gun_spec.rb

@@ -59,7 +59,7 @@ describe "CapGun" do
   end
   
   describe "handling release time" do
-    include CapGun::Helper
+      include CapGun::Helper
     
     before do # make DateTime act as if local timezone is EDT
       stubs(:local_timezone).returns("EDT")
@@ -112,4 +112,22 @@ describe "CapGun" do
     end
   end
   
+  describe "creating body" do
+    it "has a friendly summary line" do
+      CapGun::Mailer.any_instance.stubs(:current_user).returns("jdoe")
+      capistrano = { :application => "my app", :rails_env => "staging", :current_release => "/data/foo/releases/20080227120000", :cap_gun_email_envelope => { :from => "booyakka!@example.com", :recipients => ["foo@here.com", "bar@here.com"] } }
+      mail = CapGun::Mailer.create_deployment_notification capistrano
+      mail.body.split("\n").first.should == "my app was deployed to staging by jdoe at February 27th, 2008 8:00 AM EDT."
+    end
+
+    it "does not include rails env in summary if not defined" do
+      CapGun::Mailer.any_instance.stubs(:current_user).returns("jdoe")
+      capistrano = { :application => "my app", :current_release => "/data/foo/releases/20080227120000", :cap_gun_email_envelope => { :from => "booyakka!@example.com", :recipients => ["foo@here.com", "bar@here.com"] } }
+      mail = CapGun::Mailer.create_deployment_notification capistrano
+      mail.subject.should == "[DEPLOY] my app deployed" 
+      mail.body.split("\n").first.should == "my app was deployed by jdoe at February 27th, 2008 8:00 AM EDT."
+    end
+    
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cap_gun
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors: 
 - Rob Sanheim, Relevance
@@ -9,10 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-20 00:00:00 -04:00
+date: 2008-07-04 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Super simple capistrano deployments.
 email: opensource@thinkrelevance.com
 executables: []
@@ -25,12 +44,14 @@ extra_rdoc_files:
 - MIT-LICENSE
 - README.rdoc
 files: 
+- cap_gun.gemspec
 - CHANGELOG
 - init.rb
 - install.rb
 - lib/cap_gun.rb
 - manifest.txt
 - MIT-LICENSE
+- Rakefile
 - README.rdoc
 - spec/cap_gun_spec.rb
 - tasks/cap_bot_tasks.rake
@@ -39,7 +60,6 @@ files:
 - vendor/action_mailer_tls/README
 - vendor/action_mailer_tls/sample/mailer.yml.sample
 - vendor/action_mailer_tls/sample/smtp_gmail.rb
-- cap_gun.gemspec
 has_rdoc: true
 homepage: http://opensource.thinkrelevance.com/wiki/cap_gun
 post_install_message: 
@@ -60,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - "="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 
 rubyforge_project: thinkrelevance
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Bang! You're deployed!