captainu-chinook 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72f7231f7bab8df6d487ebbc799745ca4e07b364
-  data.tar.gz: 613b87cdefc9d478a4cfb9114ae6474d1b3ca819
+  metadata.gz: 1778f8d37556f4b4a65a329c4ec0128f34074a4a
+  data.tar.gz: 9662d34283a768b7adade4706d5dec3919a67cc7
 SHA512:
-  metadata.gz: 3667a63b2a5aacc28e564ee0f1bd0fcedae23eea2e0b272a31e09f71b7e06635976aead2692a6f92dbdf8afc691d296cd760ab5b320025c2e7c4a61655d77fdf
-  data.tar.gz: d525ba3dae3bc502511f1ab3d61ed7ca2a6bc838e8bad8934801cbcd37a0094691710fa7e5e19fff55ddff7beac61bf70f0a37a984976d13348c62e77a26a816
+  metadata.gz: cf7b010d705aca7648b2f608996c5f40736e771d5cbee456abc4bf2170d1e4016b75479746a653d8b2a64040560b52d3c3f38324789772b7bcb1216a52742a57
+  data.tar.gz: 3c190f81aa55f09c2263526599ffe5b9bc477aed31e6e730b8a3ce950d80353df8e8b9fef9bdbfe6b3ed3ca8d1ab34e03966972ad099c191bdfb74c692550c6e

data/chinook.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'capistrano', '~> 2.15.5'
   spec.add_runtime_dependency 'tinder', '~> 1.9.4'
+  spec.add_runtime_dependency 'slack-notifier', '~> 0.4.1'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'

data/lib/chinook/capistrano/slack.rb

@@ -0,0 +1,86 @@
+# Defines a task that will let a Slack channel know about a deploy.
+require 'capistrano'
+require 'slack-notifier'
+
+module Chinook::Capistrano
+  module Slack
+    def self.load_into(configuration)
+      configuration.load do
+        namespace :chinook do
+          desc 'Lets a Slack channel know about a deploy that has begun.'
+          task :slack_start, except: { no_release: true } do
+            unless exists?(:slack_channel) && exists?(:slack_token) && exists?(:slack_team)
+              logger.info 'Cannot notify Slack without :slack_channel, :slack_token, and :slack_team. Skipping task.'
+              next
+            end
+
+            project_name = fetch(:project_name, application)
+            git_username = `git config user.name`.chomp
+
+            message = "#{git_username} started a deploy of #{project_name} to #{stage} at #{Time.now.strftime('%r %Z')}."
+            message = ":shipit: #{message}" if fetch(:slack_shipit)
+
+            slack = ::Slack::Notifier.new(fetch(:slack_team),
+                                          fetch(:slack_token))
+            slack.channel = fetch(:slack_channel)
+            slack.username = fetch(:slack_username)
+
+            icon = fetch(:slack_icon_url)
+            opts = { icon_url: icon } if icon
+            slack.ping message, opts
+          end
+
+          desc 'Lets a Slack channel know about a deploy that is rolling back.'
+          task :slack_rollback, except: { no_release: true } do
+            unless exists?(:slack_channel) && exists?(:slack_token) && exists?(:slack_team)
+              logger.info 'Cannot notify Slack without :slack_channel, :slack_token, and :slack_team. Skipping task.'
+              next
+            end
+
+            project_name = fetch(:project_name, application)
+            git_username = `git config user.name`.chomp
+
+            message = "#{git_username}'s deploy of #{project_name} to #{stage} has been rolled back at #{Time.now.strftime('%r %Z')}."
+            message = ":shipit: #{message}" if fetch(:slack_shipit)
+
+            slack = ::Slack::Notifier.new(fetch(:slack_team),
+                                          fetch(:slack_token))
+            slack.channel = fetch(:slack_channel)
+            slack.username = fetch(:slack_username)
+
+            icon = fetch(:slack_icon_url)
+            opts = { icon_url: icon } if icon
+            slack.ping message, opts
+          end
+
+          desc 'Lets a Slack channel know about a deploy that has finished.'
+          task :slack_end, except: { no_release: true } do
+            unless exists?(:slack_channel) && exists?(:slack_token) && exists?(:slack_team)
+              logger.info 'Cannot notify Slack without :slack_channel, :slack_token, and :slack_team. Skipping task.'
+              next
+            end
+
+            project_name = fetch(:project_name, application)
+            git_username = `git config user.name`.chomp
+
+            message = "#{git_username}'s deploy of #{project_name} to #{stage} finished at #{Time.now.strftime('%r %Z')}."
+            message = ":shipit: #{message}" if fetch(:slack_shipit)
+
+            slack = ::Slack::Notifier.new(fetch(:slack_team),
+                                          fetch(:slack_token))
+            slack.channel = fetch(:slack_channel)
+            slack.username = fetch(:slack_username)
+
+            icon = fetch(:slack_icon_url)
+            opts = { icon_url: icon } if icon
+            slack.ping message, opts
+          end
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Chinook::Capistrano::Slack.load_into(Capistrano::Configuration.instance)
+end

data/lib/chinook/capistrano.rb

@@ -3,4 +3,6 @@ module Chinook
   end
 end
 
-%w(campfire passenger ping symlink).each { |m| require "chinook/capistrano/#{m}" }
+%w(campfire passenger ping slack symlink).each do |m|
+  require "chinook/capistrano/#{m}"
+end

data/lib/chinook/version.rb

@@ -1,3 +1,3 @@
 module Chinook
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/readme.markdown

@@ -73,6 +73,27 @@ Pings the site after a [Passenger](phusionpassenger.com) deploy to ensure that i
 * Settings:
     - `:ping_url`: the URL you'd like to ping to wake up. *Environment specific.*
 
+### Slack notification
+
+Notifies [Slack](https://slack.com) when a deploy starts and/or stops. Uses the value of `git config user.name` for identifying the deploying user.
+
+* Tasks:
+    - `chinook:slack_start`
+    - `chinook:slack_fail`
+    - `chinook:slack_end`
+* Hooks:
+    - `before 'deploy', 'chinook:slack_start'`
+    - `after 'deploy:rollback', 'chinook:slack_rollback'`
+    - `after 'deploy', 'chinook:slack_end'`
+* Settings:
+    - `:slack_channel`: the room/channel where notifications will be posted.
+    - `:slack_token`: the Slack webhook token for your team.
+    - `:slack_team`: the subdomain of your Slack account (**this-part**.slack.com).
+    - `:slack_username`: the username to be used when posting the message.
+    - `:project_name`: the name of your project as it will show up in the notifications. *Optional; if not supplied, the value of `:application` will be used.*
+    - `:slack_icon_url`: the URL to an icon to be used as the icon of the posting webhook. *Optional; if not supplied, Slack's default icon will be used.*
+    - `:slack_shipit`: if true, shows the `:shipit:` emoji in the message.
+
 ### Symlink
 
 Symlinks directories from various other directories into your project.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: captainu-chinook
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ben Kreeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.9.4
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +96,7 @@ files:
 - lib/chinook/capistrano/campfire.rb
 - lib/chinook/capistrano/passenger.rb
 - lib/chinook/capistrano/ping.rb
+- lib/chinook/capistrano/slack.rb
 - lib/chinook/capistrano/symlink.rb
 - lib/chinook/version.rb
 - license.markdown