slackistrano 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2221a5e8c65f2a1a082d139cc9cdaf7bb266285
-  data.tar.gz: f6b272f31ed0920fb37c1df17830c2908b7f3631
+  metadata.gz: 95795f6130f67bf6c4845feace7deaa858fb042d
+  data.tar.gz: eb3cb8e5d6ecbf13633896090d9ab6831ff05b0b
 SHA512:
-  metadata.gz: 6d128baa0d6b1605117c0f9fa5ead20d8b306b28672e5efb10fc7a6df6a672c47d1a7b449967960b373e7e417c673e25e83eed23af6e5147070ab3457aff350a
-  data.tar.gz: 7e696369664825849d4908e8d90c20abb48541ecfcda1047d064f4e99238217de7bf9e0bcb0ef673717d455e0a20657ded8cac0f07516b14c888966215e02429
+  metadata.gz: 84cb6025b635f7d6c30c47d6aaa698d3fc90707228f924e1e41fd4eddef13166743e92abb1f557710605ebe7d9a8444f0e6af95949df3321d848481cc8499ab9
+  data.tar.gz: f8c2d366313f7854f7f90e8a3b6c4ffd45ea1c6fef9558c9a2c7fa826a033a831e8e118b3754fca77c343613d8a285c17a810d662e3160590ff1347a92a106af

data/.gitignore

@@ -1,2 +1,3 @@
 pkg
 Gemfile.lock
+tmp

data/.travis.yml

@@ -1,5 +1,8 @@
+sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.2.0
-  - 2.1.0
+  - 2.3.0
+  - 2.2.4
+  - 2.1.7
   - 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Slackistrano Change Log
 
+1.1.0
+-----
+
+- Honor Capistrano's `--dry-run` [#33]
+- Better error reporting if Slack API returns failure [#40]
+- Allow posting to multiple channels by setting `:slack_channel` to an array [#37]
+
 
 1.0.0
 -----

data/README.md

@@ -58,6 +58,13 @@ set :slack_token, "xxxxxxxxxxxxxxxxxxxxxxxx"
 set :slack_channel, '#general'
 ```
 
+You can set `:slack_channel` (or any of the `:slack_channel_xxxx` settings) to an array and Slackistrano
+will post to each channel. For example:
+
+```ruby
+set :slack_channel, ['#general', '#ops']
+```
+
 Optionally, override the other slack settings.
 
 ```ruby
@@ -128,11 +135,10 @@ $ cap production slack:deploy:failed
 Slack allows you to send complex content, composed by fields. You can use the `fields` and `fallback` variables in order to have a well formatted message as follows:
 
 ```ruby
-set :slack_revision, `git rev-parse origin/master`.strip!
-set :slack_title_finished, nil
-set :slack_msg_finished, nil
-set :slack_fallback_finished, "#{fetch(:slack_deploy_user)} deployed #{fetch(:application)} on #{fetch(:stage)}"
-set :slack_fields_finished, [
+set :slack_revision, `git rev-parse origin/#{fetch(:branch)}`.strip!
+set :slack_msg_updated, nil
+set :slack_fallback_updated, "#{fetch(:slack_deploy_user)} deployed #{fetch(:application)} on #{fetch(:stage)}"
+set :slack_fields_updated, [
   {
     "title": "Project",
     "value": "<https://github.com/XXXXX/#{fetch(:application)}|#{fetch(:application)}>",

data/lib/slackistrano/tasks/slack.rake

@@ -1,5 +1,6 @@
 namespace :slack do
   namespace :deploy do
+
     def make_attachments(stage, options={})
       attachments = options.merge({
         title: fetch(:"slack_title_#{stage}"),
@@ -12,23 +13,84 @@ namespace :slack do
       [attachments]
     end
 
+    def make_payload(stage)
+      payload = {
+        username: fetch(:slack_username),
+        icon_url: fetch(:slack_icon_url),
+        icon_emoji: fetch(:slack_icon_emoji),
+      }
+
+
+      payload[:attachments] = case stage
+                            when :updated
+                              make_attachments(stage, color: 'good')
+                            when :reverted
+                              make_attachments(stage, color: '#4CBDEC')
+                            when :failed
+                              make_attachments(stage, color: 'danger')
+                            else
+                              make_attachments(stage)
+                            end
+
+      payload
+    end
+
+    def post_message(stage)
+      team = fetch(:slack_team)
+      token = fetch(:slack_token)
+      webhook = fetch(:slack_webhook)
+      via_slackbot = fetch(:slack_via_slackbot)
+      payload = make_payload(stage)
+
+      channels = fetch(:slack_channel)
+      stage_channel = "slack_channel_#{stage.to_s}".to_sym
+      if fetch(stage_channel)
+        channels = fetch(stage_channel)
+      end
+      channels = Array(channels)
+      if via_slackbot == false && channels.empty?
+        channels = [nil] # default webhook channel
+      end
+
+      channels.each do |channel|
+        payload[:channel] = channel
+
+        # This is a nasty hack, but until Capistrano provides an official way to determine if
+        # --dry-run was passed this is the only option.
+        # See https://github.com/capistrano/capistrano/issues/1462
+        if Capistrano::Configuration.env.send(:config)[:sshkit_backend] == SSHKit::Backend::Printer
+          info("[slackistrano] Slackistrano Dry Run:")
+          info("[slackistrano]   Team: #{team}")
+          info("[slackistrano]   Webhook: #{webhook}")
+          info("[slackistrano]   Via Slackbot: #{via_slackbot}")
+          info("[slackistrano]   Payload: #{payload.to_json}")
+
+        # Post to the channel.
+        else
+          http_response = Slackistrano.post(team: team,
+                                            token: token,
+                                            webhook: webhook,
+                                            via_slackbot: via_slackbot,
+                                            payload: payload)
+          if http_response.code !~ /^2/
+            error("[slackistrano] Slack API Failure!")
+            error("[slackistrano]   URI: #{http_response.uri}")
+            error("[slackistrano]   Code: #{http_response.code}")
+            error("[slackistrano]   Message: #{http_response.message}")
+            error("[slackistrano]   Body: #{http_response.body}") if http_response.message != http_response.body
+          end
+        end
+      end
+
+    end
+
+    ######################################################################
+
     task :updating do
       set(:slack_deploy_or_rollback, 'deploy')
       if fetch(:slack_run_updating)
         run_locally do
-          Slackistrano.post(
-            team: fetch(:slack_team),
-            token: fetch(:slack_token),
-            webhook: fetch(:slack_webhook),
-            via_slackbot: fetch(:slack_via_slackbot),
-            payload: {
-              channel: fetch(:slack_channel_updating) || fetch(:slack_channel),
-              username: fetch(:slack_username),
-              icon_url: fetch(:slack_icon_url),
-              icon_emoji: fetch(:slack_icon_emoji),
-              attachments: make_attachments(:updating)
-            }
-          )
+          post_message(:updating)
         end
       end
     end
@@ -37,40 +99,15 @@ namespace :slack do
       set(:slack_deploy_or_rollback, 'rollback')
       if fetch(:slack_run_reverting)
         run_locally do
-          Slackistrano.post(
-            team: fetch(:slack_team),
-            token: fetch(:slack_token),
-            webhook: fetch(:slack_webhook),
-            via_slackbot: fetch(:slack_via_slackbot),
-            payload: {
-              channel: fetch(:slack_channel_reverting) || fetch(:slack_channel),
-              username: fetch(:slack_username),
-              icon_url: fetch(:slack_icon_url),
-              icon_emoji: fetch(:slack_icon_emoji),
-              attachments: make_attachments(:reverting)
-            }
-          )
+          post_message(:reverting)
         end
       end
     end
 
-
     task :updated do
       if fetch(:slack_run_updated)
         run_locally do
-          Slackistrano.post(
-            team: fetch(:slack_team),
-            token: fetch(:slack_token),
-            webhook: fetch(:slack_webhook),
-            via_slackbot: fetch(:slack_via_slackbot),
-            payload: {
-              channel: fetch(:slack_channel_updated) || fetch(:slack_channel),
-              username: fetch(:slack_username),
-              icon_url: fetch(:slack_icon_url),
-              icon_emoji: fetch(:slack_icon_emoji),
-              attachments: make_attachments(:updated, color: 'good')
-            }
-          )
+           post_message(:updated)
         end
       end
     end
@@ -78,19 +115,7 @@ namespace :slack do
     task :reverted do
       if fetch(:slack_run_reverted)
         run_locally do
-          Slackistrano.post(
-            team: fetch(:slack_team),
-            token: fetch(:slack_token),
-            webhook: fetch(:slack_webhook),
-            via_slackbot: fetch(:slack_via_slackbot),
-            payload: {
-              channel: fetch(:slack_channel_reverted) || fetch(:slack_channel),
-              username: fetch(:slack_username),
-              icon_url: fetch(:slack_icon_url),
-              icon_emoji: fetch(:slack_icon_emoji),
-              attachments: make_attachments(:reverted, color: '#4CBDEC')
-            }
-          )
+          post_message(:reverted)
         end
       end
     end
@@ -98,19 +123,7 @@ namespace :slack do
     task :failed do
       if fetch(:slack_run_failed)
         run_locally do
-          Slackistrano.post(
-            team: fetch(:slack_team),
-            token: fetch(:slack_token),
-            webhook: fetch(:slack_webhook),
-            via_slackbot: fetch(:slack_via_slackbot),
-            payload: {
-              channel: fetch(:slack_channel_failed) || fetch(:slack_channel),
-              username: fetch(:slack_username),
-              icon_url: fetch(:slack_icon_url),
-              icon_emoji: fetch(:slack_icon_emoji),
-              attachments: make_attachments(:failed, color: 'danger')
-            }
-          )
+          post_message(:failed)
         end
       end
     end

data/lib/slackistrano/version.rb

@@ -1,3 +1,3 @@
 module Slackistrano
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/slackistrano.rb

@@ -16,8 +16,8 @@ module Slackistrano
       post_as_webhook(team: team, token: token, webhook: webhook, payload: payload)
     end
   rescue => e
-    puts "There was an error notifying Slack."
-    puts e.inspect
+    error("[slackistrano] Error notifying Slack!")
+    error("[slackistrano]   Error: #{e.inspect}")
   end
 
   #
@@ -29,7 +29,7 @@ module Slackistrano
     text = payload[:attachments].collect { |a| a[:text] }.join("\n")
 
     Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-      http.request_post uri.request_uri, text
+      http.request_post uri, text
     end
   end
 
@@ -48,6 +48,4 @@ module Slackistrano
     Net::HTTP.post_form(uri, params)
   end
 
-
 end
-

data/slackistrano.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'json'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
 end

data/spec/tasks_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Slackistrano do
   before(:each) do
-    Rake::Task['load:defaults'].invoke
+    Rake::Task['load:defaults'].execute
   end
 
   describe "before/after hooks" do
@@ -35,17 +35,40 @@ describe Slackistrano do
   %w[updating reverting updated reverted failed].each do |stage|
     it "posts to slack on slack:deploy:#{stage}" do
       set "slack_run_#{stage}".to_sym, ->{ true }
-      expect(Slackistrano).to receive :post
+      expect(Slackistrano).to receive(:post).and_return(double(code: '200'))
       Rake::Task["slack:deploy:#{stage}"].execute
     end
 
     it "does not post to slack on slack:deploy:#{stage} when disabled" do
       set "slack_run_#{stage}".to_sym, ->{ false }
-      expect(Slackistrano).not_to receive :post
+      expect(Slackistrano).not_to receive(:post)
       Rake::Task["slack:deploy:#{stage}"].execute
     end
   end
 
+  context "when :slack_channel is an array" do
+    %w[updating reverting updated reverted failed].each do |stage|
+      it "posts to slack on slack:deploy:#{stage} in every channel" do
+        set "slack_channel".to_sym, ->{ %w[one two] }
+        set "slack_run_#{stage}".to_sym, ->{ true }
+        expect(Slackistrano).to receive(:post).twice.and_return(double(code: '200'))
+        Rake::Task["slack:deploy:#{stage}"].execute
+      end
+    end
+  end
+
+  context "when --dry-run is passed" do
+    %w[updating reverting updated reverted failed].each do |stage|
+      it "does not post to slack on slack:deploy:#{stage}" do
+        set "slack_run_#{stage}".to_sym, ->{ true }
+        expect(Capistrano::Configuration.env.send(:config)).to receive(:[]).with(:sshkit_backend).and_return(SSHKit::Backend::Printer)
+        expect(Slackistrano).not_to receive(:post)
+        Rake::Task["slack:deploy:#{stage}"].execute
+      end
+    end
+  end
+
+
   [ # stage, color, channel
     ['updating', nil, nil],
     ['reverting', nil, nil],
@@ -91,7 +114,7 @@ describe Slackistrano do
           icon_emoji: ':emoji:',
           attachments: [attachment]
         }
-      )
+      ).and_return(double(code: '200'))
       Rake::Task["slack:deploy:#{stage}"].execute
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slackistrano
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Philip Hallstrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2016-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Send notifications to Slack about Capistrano deployments.
 email:
 - philip@pjkh.com
@@ -108,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Send notifications to Slack about Capistrano deployments.