slackistrano 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aee7cb384807fb00bce41d808dcf1c147673237
-  data.tar.gz: 6849e3a8506f73c0efc7002afc34c42ee2ae88fc
+  metadata.gz: 851d5d5bb98527246ddb446956250f5670007aca
+  data.tar.gz: bf3821250a52f2c3c5fcd7212a192e38878fb56b
 SHA512:
-  metadata.gz: c7b9457420f08b96541d278ce5ef92a57d178b49c321a4bf3036b478a4a2c8d63f177b155d5b75bc0fc646b73a20aea3cf4fdd1debbf23f57812ca5245ffc34b
-  data.tar.gz: 7a61dec6f4c406987ea4d797d1a1ed5447af0b070349b77fc2cd92d241baa1c00a9d875059ee7be8eee136c2be1ee639a69fcd8654ab04c3f8d13d311f1ea7c3
+  metadata.gz: 36d3edcd7e42fbcb65ca35e641922666ce9d3ee7b00acf3bcda56478041cb1d12fc46b8923a1fd4abfb992efd120daaa10aadb732638f3262188562068014734
+  data.tar.gz: d8ebee206e6a4ab2ef7fa5f5304cfbe47c4d8d984fe59d4e847d502c3420e25510112ebab258a65b05f27277c99d6c6b444ba99cad92bf8318593afa283f505a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Slackistrano Change Log
 
+2.0.1
+-----
+
+- Internal code refactoring. No public facing changes.
+
 2.0.0
 -----
 

data/README.md

@@ -83,6 +83,7 @@ set :slack_icon_url,           -> { 'http://gravatar.com/avatar/885e1c523b7975c4
 set :slack_icon_emoji,         -> { nil } # Emoji to use. Overrides icon_url. Must be a string (ex: ':shipit:')
 set :slack_username,           -> { 'Slackistrano' }
 
+set :slack_run,                -> { true } # Set to false to disable all messages.
 set :slack_run_updating,       -> { true } # Set to false to disable deploy starting message.
 set :slack_run_reverting,      -> { true } # Set to false to disable rollback starting message.
 set :slack_run_updated,        -> { true } # Set to false to disable deploy finished message.
@@ -184,7 +185,6 @@ you specified.
 ## TODO
 
 - Notify about incorrect configuration settings.
-- Notify about unsuccessfull HTTP POSTs.
 
 ## Contributing
 

data/lib/slackistrano/capistrano.rb

@@ -1,50 +1,166 @@
 require 'net/http'
 require 'json'
+require 'forwardable'
 
 load File.expand_path("../tasks/slack.rake", __FILE__)
 
 module Slackistrano
+  class Capistrano
 
-  #
-  #
-  #
-  def self.post(team: nil, token: nil, webhook: nil, via_slackbot: false, payload: {})
-    if via_slackbot
-      post_as_slackbot(team: team, token: token, webhook: webhook, payload: payload)
-    else
-      post_as_webhook(team: team, token: token, webhook: webhook, payload: payload)
+    extend Forwardable
+    def_delegators :env, :fetch, :run_locally
+
+    #
+    #
+    #
+    def initialize(env)
+      @env = env
     end
-  rescue => e
-    error("[slackistrano] Error notifying Slack!")
-    error("[slackistrano]   Error: #{e.inspect}")
-  end
 
-  #
-  #
-  #
-  def self.post_as_slackbot(team: nil, token: nil, webhook: nil, payload: {})
-    uri = URI(URI.encode("https://#{team}.slack.com/services/hooks/slackbot?token=#{token}&channel=#{payload[:channel]}"))
+    #
+    #
+    #
+    def run(action)
+      should_run = fetch("slack_run".to_sym)
+      should_run &&= fetch("slack_run_#{action}".to_sym)
+      return unless should_run
 
-    text = payload[:attachments].collect { |a| a[:text] }.join("\n")
+      _self = self
+      run_locally { _self.post(action, self) }
 
-    Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-      http.request_post uri, text
     end
-  end
 
-  #
-  #
-  #
-  def self.post_as_webhook(team: nil, token: nil, webhook: nil, payload: {})
-    params = {'payload' => payload.to_json}
+    #
+    #
+    #
+    def post(action, backend)
+      team = fetch(:slack_team)
+      token = fetch(:slack_token)
+      webhook = fetch(:slack_webhook)
+      via_slackbot = fetch(:slack_via_slackbot)
+
+      channels = fetch(:slack_channel)
+      channel_action = "slack_channel_#{action}".to_sym
+      channels = fetch(channel_action) if fetch(channel_action)
+      channels = Array(channels)
+      if via_slackbot == false && channels.empty?
+        channels = [nil] # default webhook channel
+      end
+
+      payload = {
+        username: fetch(:slack_username),
+        icon_url: fetch(:slack_icon_url),
+        icon_emoji: fetch(:slack_icon_emoji),
+      }
+
+      payload[:attachments] = case action
+                              when :updated
+                                make_attachments(action, color: 'good')
+                              when :reverted
+                                make_attachments(action, color: '#4CBDEC')
+                              when :failed
+                                make_attachments(action, color: 'danger')
+                              else
+                                make_attachments(action)
+                              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
+          backend.info("[slackistrano] Slackistrano Dry Run:")
+          backend.info("[slackistrano]   Team: #{team}")
+          backend.info("[slackistrano]   Webhook: #{webhook}")
+          backend.info("[slackistrano]   Via Slackbot: #{via_slackbot}")
+          backend.info("[slackistrano]   Payload: #{payload.to_json}")
+
+        # Post to the channel.
+        else
+
+          begin
+            response = post_to_slack(team: team,
+                                     token: token,
+                                     webhook: webhook,
+                                     via_slackbot: via_slackbot,
+                                     payload: payload)
+
+          rescue => e
+            backend.warn("[slackistrano] Error notifying Slack!")
+            backend.warn("[slackistrano]   Error: #{e.inspect}")
+          end
+
+          if response.code !~ /^2/
+            warn("[slackistrano] Slack API Failure!")
+            warn("[slackistrano]   URI: #{response.uri}")
+            warn("[slackistrano]   Code: #{response.code}")
+            warn("[slackistrano]   Message: #{response.message}")
+            warn("[slackistrano]   Body: #{response.body}") if response.message != response.body && response.body !~ /<html/
+          end
+        end
+      end
 
-    if webhook.nil?
-      webhook = "https://#{team}.slack.com/services/hooks/incoming-webhook"
-      params.merge!('token' => token)
     end
 
-    uri = URI(webhook)
-    Net::HTTP.post_form(uri, params)
-  end
+    #
+    #
+    #
+    def make_attachments(action, options={})
+      attachments = options.merge({
+        title:      fetch(:"slack_title_#{action}"),
+        pretext:    fetch(:"slack_pretext_#{action}"),
+        text:       fetch(:"slack_msg_#{action}"),
+        fields:     fetch(:"slack_fields_#{action}"),
+        fallback:   fetch(:"slack_fallback_#{action}"),
+        mrkdwn_in:  [:text, :pretext]
+      }).reject{|k, v| v.nil? }
+      [attachments]
+    end
+    private :make_attachments
+
+    #
+    #
+    #
+    def post_to_slack(via_slackbot: nil, team: nil, token: nil, webhook: nil, payload: {})
+      if via_slackbot
+        post_as_slackbot(team: team, token: token, webhook: webhook, payload: payload)
+      else
+        post_as_webhook(team: team, token: token, webhook: webhook, payload: payload)
+      end
+    end
+    private :post_to_slack
+
+    #
+    #
+    #
+    def post_as_slackbot(team: nil, token: nil, webhook: nil, payload: {})
+      uri = URI(URI.encode("https://#{team}.slack.com/services/hooks/slackbot?token=#{token}&channel=#{payload[:channel]}"))
+
+      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, text
+      end
+    end
+    private :post_as_slackbot
+
+    #
+    #
+    #
+    def post_as_webhook(team: nil, token: nil, webhook: nil, payload: {})
+      params = {'payload' => payload.to_json}
+
+      if webhook.nil?
+        webhook = "https://#{team}.slack.com/services/hooks/incoming-webhook"
+        params.merge!('token' => token)
+      end
 
+      uri = URI(webhook)
+      Net::HTTP.post_form(uri, params)
+    end
+    private :post_as_webhook
+
+  end
 end

data/lib/slackistrano/tasks/slack.rake

@@ -1,131 +1,26 @@
 namespace :slack do
   namespace :deploy do
 
-    def make_attachments(stage, options={})
-      attachments = options.merge({
-        title: fetch(:"slack_title_#{stage}"),
-        pretext: fetch(:"slack_pretext_#{stage}"),
-        text: fetch(:"slack_msg_#{stage}"),
-        fields: fetch(:"slack_fields_#{stage}"),
-        fallback: fetch(:"slack_fallback_#{stage}"),
-        mrkdwn_in: [:text, :pretext]
-      }).reject{|k, v| v.nil? }
-      [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
-          post_message(:updating)
-        end
-      end
+      Slackistrano::Capistrano.new(self).run(:updating)
     end
 
     task :reverting do
       set(:slack_deploy_or_rollback, 'rollback')
-      if fetch(:slack_run_reverting)
-        run_locally do
-          post_message(:reverting)
-        end
-      end
+      Slackistrano::Capistrano.new(self).run(:reverting)
     end
 
     task :updated do
-      if fetch(:slack_run_updated)
-        run_locally do
-           post_message(:updated)
-        end
-      end
+      Slackistrano::Capistrano.new(self).run(:updated)
     end
 
     task :reverted do
-      if fetch(:slack_run_reverted)
-        run_locally do
-          post_message(:reverted)
-        end
-      end
+      Slackistrano::Capistrano.new(self).run(:reverted)
     end
 
     task :failed do
-      if fetch(:slack_run_failed)
-        run_locally do
-          post_message(:failed)
-        end
-      end
+      Slackistrano::Capistrano.new(self).run(:failed)
     end
 
   end
@@ -140,11 +35,11 @@ after  'deploy:failed',             'slack:deploy:failed'
 namespace :load do
   task :defaults do
 
-    set :slack_team,               -> { nil } # If URL is 'team.slack.com', value is 'team'.
-    set :slack_token,              -> { nil } # Token from Incoming WebHooks.
-    set :slack_webhook,            -> { nil } # Incoming WebHook URL.
+    set :slack_team,               -> { nil }   # If URL is 'team.slack.com', value is 'team'.
+    set :slack_token,              -> { nil }   # Token from Incoming WebHooks.
+    set :slack_webhook,            -> { nil }   # Incoming WebHook URL.
     set :slack_via_slackbot,       -> { false } # Set to true to send the message via slackbot instead of webhook
-    set :slack_channel,            -> { nil } # Channel to post to. Optional. Defaults to WebHook setting.
+    set :slack_channel,            -> { nil }   # Channel to post to. Optional. Defaults to WebHook setting.
 
     # Optional, overridable settings
 
@@ -158,6 +53,7 @@ namespace :load do
     set :slack_icon_emoji,         -> { nil } # Emoji to use. Overrides icon_url. Must be a string (ex: ':shipit:')
     set :slack_username,           -> { 'Slackistrano' }
 
+    set :slack_run,                -> { true } # Set to false to disable all messages.
     set :slack_run_updating,       -> { true } # Set to false to disable deploy starting message.
     set :slack_run_reverting,      -> { true } # Set to false to disable rollback starting message.
     set :slack_run_updated,        -> { true } # Set to false to disable deploy finished message.

data/lib/slackistrano/version.rb

@@ -1,3 +1,3 @@
 module Slackistrano
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/spec/dry_run_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Slackistrano do
+  before(:each) do
+    Rake::Task['load:defaults'].execute
+  end
+
+  %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

data/spec/posting_to_multiple_channels_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Slackistrano do
+  before(:each) do
+    Rake::Task['load:defaults'].execute
+  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_any_instance_of(Slackistrano::Capistrano).to receive(:post_to_slack).twice.and_return(double(code: '200'))
+        Rake::Task["slack:deploy:#{stage}"].execute
+      end
+    end
+  end
+
+end

data/spec/task_hooks_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Slackistrano do
+  before(:each) do
+    Rake::Task['load:defaults'].execute
+  end
+
+  describe "before/after hooks" do
+
+    it "invokes slack:deploy:updating before deploy:updating" do
+      expect(Rake::Task['deploy:updating'].prerequisites).to include 'slack:deploy:updating'
+    end
+
+    it "invokes slack:deploy:reverting before deploy:reverting" do
+      expect(Rake::Task['deploy:reverting'].prerequisites).to include 'slack:deploy:reverting'
+    end
+
+    it "invokes slack:deploy:updated after deploy:finishing" do
+      expect(Rake::Task['slack:deploy:updated']).to receive(:invoke)
+      Rake::Task['deploy:finishing'].execute
+    end
+
+    it "invokes slack:deploy:reverted after deploy:finishing_rollback" do
+      expect(Rake::Task['slack:deploy:reverted']).to receive(:invoke)
+      Rake::Task['deploy:finishing_rollback'].execute
+    end
+
+    it "invokes slack:deploy:failed after deploy:failed" do
+      expect(Rake::Task['slack:deploy:failed']).to receive(:invoke)
+      Rake::Task['deploy:failed'].execute
+    end
+
+  end
+
+end

data/spec/tasks_spec.rb

@@ -5,70 +5,27 @@ describe Slackistrano do
     Rake::Task['load:defaults'].execute
   end
 
-  describe "before/after hooks" do
-
-    it "invokes slack:deploy:updating before deploy:updating" do
-      expect(Rake::Task['deploy:updating'].prerequisites).to include 'slack:deploy:updating'
-    end
-
-    it "invokes slack:deploy:reverting before deploy:reverting" do
-      expect(Rake::Task['deploy:reverting'].prerequisites).to include 'slack:deploy:reverting'
-    end
-
-    it "invokes slack:deploy:updated after deploy:finishing" do
-      expect(Rake::Task['slack:deploy:updated']).to receive(:invoke)
-      Rake::Task['deploy:finishing'].execute
-    end
-
-    it "invokes slack:deploy:reverted after deploy:finishing_rollback" do
-      expect(Rake::Task['slack:deploy:reverted']).to receive(:invoke)
-      Rake::Task['deploy:finishing_rollback'].execute
-    end
-
-    it "invokes slack:deploy:failed after deploy:failed" do
-      expect(Rake::Task['slack:deploy:failed']).to receive(:invoke)
-      Rake::Task['deploy:failed'].execute
-    end
-
-  end
-
   %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).and_return(double(code: '200'))
+      expect_any_instance_of(Slackistrano::Capistrano).to receive(:post_to_slack).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_any_instance_of(Slackistrano::Capistrano).not_to receive(:post_to_slack)
       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
+    it "does not post to slack on slack:deploy:#{stage} when disabled globally" do
+      set "slack_run".to_sym, ->{ false }
+      set "slack_run_#{stage}".to_sym, ->{ true }
+      expect_any_instance_of(Slackistrano::Capistrano).not_to receive(:post_to_slack)
+      Rake::Task["slack:deploy:#{stage}"].execute
     end
   end
 
-
   [ # stage, color, channel
     ['updating', nil, nil],
     ['reverting', nil, nil],
@@ -81,7 +38,7 @@ describe Slackistrano do
     ['failed', 'danger', 'failed_channel'],
   ].each do |stage, color, channel_for_stage|
 
-    it "calls Slackistrano.post with the right arguments for stage=#{stage}, color=#{color}, channel_for_stage=#{channel_for_stage}" do
+    it "calls post_as_slack with the right arguments for stage=#{stage}, color=#{color}, channel_for_stage=#{channel_for_stage}" do
       set :"slack_run_#{stage}", -> { true }
       set :slack_team,           -> { 'team' }
       set :slack_token,          -> { 'token' }
@@ -102,7 +59,7 @@ describe Slackistrano do
         mrkdwn_in: [:text, :pretext]
       }.reject{|k,v| v.nil?}
 
-      expect(Slackistrano).to receive(:post).with(
+      expect_any_instance_of(Slackistrano::Capistrano).to receive(:post_to_slack).with(
         team: 'team',
         token: 'token',
         webhook: 'webhook',
@@ -119,5 +76,4 @@ describe Slackistrano do
     end
   end
 
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slackistrano
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Philip Hallstrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -101,7 +101,10 @@ files:
 - lib/slackistrano/version.rb
 - slackistrano.gemspec
 - spec/capistrano_deploy_stubs.rake
+- spec/dry_run_spec.rb
+- spec/posting_to_multiple_channels_spec.rb
 - spec/spec_helper.rb
+- spec/task_hooks_spec.rb
 - spec/tasks_spec.rb
 homepage: https://github.com/phallstrom/slackistrano
 licenses:
@@ -133,5 +136,8 @@ specification_version: 4
 summary: Send notifications to Slack about Capistrano deployments.
 test_files:
 - spec/capistrano_deploy_stubs.rake
+- spec/dry_run_spec.rb
+- spec/posting_to_multiple_channels_spec.rb
 - spec/spec_helper.rb
+- spec/task_hooks_spec.rb
 - spec/tasks_spec.rb