capistrano-slackify 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb7a88b489f738c1ba6819ba9f906818bad7c576
-  data.tar.gz: 2bc0070ea65b7a95b9e1494aa8d5813ff977523d
+  metadata.gz: 9b5dafba0cc5d7f3d89a6962a72fc000006f1405
+  data.tar.gz: d7f9938e73652330237b3e8ad2176ff7ff9f0c67
 SHA512:
-  metadata.gz: a6a1e2e739bf9091632ffbb43c521a6a9acc7fdd12f9834c0fb96b6916b36ab99f09ce53b62315cdbdafa03e0ce29980b851a35392237d8c54b2bc3951007763
-  data.tar.gz: b575a0979c90d7f0a216de5584eeb85e0de0969058962de83e9344313f718d76cd90b9c0e75d4b54bee80005c928fc7d172706ab11247ac21ac9a65929595277
+  metadata.gz: e95d083bc7f952d2ff386512b00cfe7231d9906bd0d65701feedb852c79005a7e684cb9a3f615bddeb03106f460f97867453c876bc48ef17693eda02dd827f0d
+  data.tar.gz: cb202d398accaa1e998b329bdee9db9488294ea4707823b32ece765ac835b3cfcd1f9d7a48a26da0c63a842e459529c512167dd77ce6f802cb349ca0915df557

data/README.md

@@ -1,4 +1,4 @@
-# Capistrano Slackify [![Build Status](https://travis-ci.org/onthebeach/capistrano-slackify.svg)](https://travis-ci.org/onthebeach/capistrano-slackify) [![Code Climate](https://codeclimate.com/github/onthebeach/capistrano-slackify/badges/gpa.svg)](https://codeclimate.com/github/onthebeach/capistrano-slackify)
+# Capistrano Slackify [![Build Status](https://travis-ci.org/onthebeach/capistrano-slackify.svg)](https://travis-ci.org/onthebeach/capistrano-slackify) [![Code Climate](https://codeclimate.com/github/onthebeach/capistrano-slackify/badges/gpa.svg)](https://codeclimate.com/github/onthebeach/capistrano-slackify) [![Gem Version](https://badge.fury.io/rb/capistrano-slackify.svg)](http://badge.fury.io/rb/capistrano-slackify)
 
 Publish deploy notifications to [Slack](https://slack.com) - for [Capistrano v3](https://github.com/capistrano/capistrano).
 
@@ -41,6 +41,14 @@ By default, this will publish something along the lines of:
 
     Revision 64a3c1de of my_app deployed to production by seenmyfate in 333 seconds.
 
+If a deploy has failed, the following message will be published by default:
+
+    production deploy of my_app with revision/branch 64a3c1de failed
+
+As with the other tasks, it is also possible to notify failures manually:
+
+    bundle exec cap production slack:notify_failed
+
 ###  Customisation
 
 Any of the defaults can be over-ridden in `config/deploy.rb`:
@@ -58,10 +66,13 @@ Any of the defaults can be over-ridden in `config/deploy.rb`:
     set :slack_deploy_starting_text, -> {
       "#{fetch(:stage)} deploy starting with revision/branch #{fetch(:current_revision, fetch(:branch))} for #{fetch(:application)}"
     }
+    set :slack_deploy_failed_text, -> {
+      "#{fetch(:stage)} deploy of #{fetch(:application)} with revision/branch #{fetch(:current_revision, fetch(:branch))} failed"
+    }
 
 To configure the way slack parses your message (see 'Parsing Modes' at https://api.slack.com/docs/formatting) use the `:slack_parse` setting:
 
-  set :slack_parse, 'none' # available options: 'default', 'none', 'full'
+    set :slack_parse, 'none' # available options: 'default', 'none', 'full'
 
 ### Copyright
 

data/capistrano-slackify.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'capistrano-slackify'
-  spec.version       = '2.0.1'
+  spec.version       = '2.1.0'
   spec.authors       = ['seenmyfate']
   spec.email         = ['seenmyfate@gmail.com']
   spec.summary       = %q{Publish deployment notifications to Slack via the incoming webhooks integration}

data/lib/capistrano/tasks/slackify.cap

@@ -5,8 +5,8 @@ namespace :slack do
     run_locally do
       info 'Notifying Slack of deploy starting'
       set :time_started, Time.now.to_i
-      execute :curl, '-X POST',
-        '--data-urlencode', Slackify::Payload.build(self, :start),
+      execute :curl, '-X POST', '--data-urlencode',
+        Slackify::Payload.build(self, fetch(:slack_deploy_starting_text)),
         fetch(:slack_url)
     end
   end
@@ -18,12 +18,25 @@ namespace :slack do
     run_locally do
       info 'Notifying Slack of deploy finished'
       set :time_finished, Time.now.to_i
-      execute :curl, '-X POST',
-        '--data-urlencode', Slackify::Payload.build(self, :finish),
+      execute :curl, '-X POST', '--data-urlencode',
+        Slackify::Payload.build(self, fetch(:slack_text)),
         fetch(:slack_url)
     end
   end
   after 'deploy:finished', 'slack:notify_finished'
+
+  desc 'Notify Slack of a deployment failure via the incoming webhooks ' \
+       'integration - :slack_subdomain and :slack_token must be set'
+  task :notify_failed do
+    run_locally do
+      info 'Notifying Slack of deploy failed'
+      set :time_finished, Time.now.to_i
+      execute :curl, '-X POST', '--data-urlencode',
+        Slackify::Payload.build(self, fetch(:slack_deploy_failed_text)),
+        fetch(:slack_url)
+    end
+  end
+  after 'deploy:failed', 'slack:notify_failed'
 end
 
 namespace :load do
@@ -43,5 +56,8 @@ namespace :load do
     set :slack_deploy_starting_text, -> {
       "#{fetch(:stage)} deploy starting with revision/branch #{fetch(:current_revision, fetch(:branch))} for #{fetch(:application)}"
     }
+    set :slack_deploy_failed_text, -> {
+      "#{fetch(:stage)} deploy of #{fetch(:application)} with revision/branch #{fetch(:current_revision, fetch(:branch))} failed"
+    }
   end
 end

data/lib/slackify.rb

@@ -3,15 +3,15 @@ require 'yajl/json_gem'
 module Slackify
   class Payload
 
-    attr_reader :status
-    protected :status
+    attr_reader :text
+    protected :text
 
-    def initialize(context, status)
-      @context, @status = context, status
+    def initialize(context, text)
+      @context, @text = context, text
     end
 
-    def self.build(context, status)
-      new(context, status).build
+    def self.build(context, text)
+      new(context, text).build
     end
 
     def build
@@ -22,20 +22,12 @@ module Slackify
       {
         channel: fetch(:slack_channel),
         username: fetch(:slack_username),
-        text: slack_text,
+        text: text,
         icon_emoji: fetch(:slack_emoji),
         parse: fetch(:slack_parse)
       }.to_json
     end
 
-    def slack_text
-      if @status == :start
-        fetch(:slack_deploy_starting_text)
-      else
-        fetch(:slack_text)
-      end
-    end
-
     def fetch(*args, &block)
       @context.fetch(*args, &block)
     end

data/spec/lib/slackify_spec.rb

@@ -11,28 +11,17 @@ module Slackify
           slack_parse: 'default',
           slack_user: 'You',
           slack_text: ':boom:',
-          slack_deploy_starting_text: 'duck!'
         }
       }
 
-      context 'when starting' do
-        let(:payload) {
-          %{'payload={"channel":"#general","username":"Capistrano","text":"duck!","icon_emoji":":ghost:","parse":"default"}'}
-        }
-
-        it 'returns the starting payload' do
-          expect(Payload.build(context, :start)).to eq payload
-        end
-      end
+      let(:payload) {
+        %{'payload={"channel":"#general","username":"Capistrano","text":":boom:","icon_emoji":":ghost:","parse":"default"}'}
+      }
 
-      context 'when finishing' do
-        let(:payload) {
-          %{'payload={"channel":"#general","username":"Capistrano","text":":boom:","icon_emoji":":ghost:","parse":"default"}'}
-        }
+      let(:text) { context.fetch(:slack_text) }
 
-        it 'returns the finishing payload' do
-          expect(Payload.build(context, :finish)).to eq payload
-        end
+      it 'returns the payload with the specified text' do
+        expect(Payload.build(context, text)).to eq payload
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-slackify
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - seenmyfate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -128,4 +128,3 @@ summary: Publish deployment notifications to Slack via the incoming webhooks int
 test_files:
 - spec/lib/slackify_spec.rb
 - spec/spec_helper.rb
-has_rdoc: