slackistrano 3.8.1 → 3.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a8353756db234daceeaa82ee93d7e09cdb1e696
-  data.tar.gz: e2270ff236ef7cb99a8a5ca9866685e72b948e5c
+  metadata.gz: 4fac68f58cb93ece5bc58a404e97e1e21189d841
+  data.tar.gz: b58e73827ae619e20a4e2a61081872177c810ac4
 SHA512:
-  metadata.gz: fb861d03629d874e95bfaa99021a77615a734ec369b2fd3d74cd9f26d71753a4ec4ef36b73e3ef6acab45b938db70c87348a655599ad5577110c093609b616f7
-  data.tar.gz: ddc5219bf447125f28518037dfbe9cb2fc4d66f08a295657bcc921d1c195c4c71cccf45ea2eefabf38bfb5d7c7afff56ffa292292c192c22813d9820a9e6bf19
+  metadata.gz: 34024139c2b12d28ddcf69428009078d931621ed75018d2c5c448464da14b6291aff0ec6193cc803bbac701c0a34b49ef977100e925d0298a26909f6b7260714
+  data.tar.gz: 5259c193fe28f066d04972abbe22345295b9ccd8f3a305a9426c26e539c911d5ebc7723ed28221e430f136fe45e767fe6408426391d20ddbbeba1d9b1ceea605

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Slackistrano Change Log
 
+3.8.2
+-----
+
+- Allow overriding icon_url, icon_emoji, and usename without needing custom
+  messaging class [#78, #68]
+
 3.8.1
 -----
 

data/README.md

@@ -66,6 +66,26 @@ You have two options to notify a channel in Slack when you deploy:
    }
    ```
 
+### Optional Configuration & Overrides
+
+By default Slackistrano will use a default icon and username. These, can be
+overriden if you are using the default messaging class (ie. have not specified
+your own).
+
+1. Configure per instructions above.
+2. Add the following to `config/deploy.rb`:
+
+   ```ruby
+   set :slackistrano, {
+    ...
+    username: 'Foobar the Deployer',
+    icon_emoji: ':thumbsup:', # takes precedence over icon_url
+    icon_url: 'https://avatars2.githubusercontent.com/u/16705?v=4&s=40',
+    ...
+   }
+   ```
+
+
 ### Test your Configuration
 
 Test your setup by running the following command. This will post each stage's
@@ -86,78 +106,83 @@ You can customize the messaging posted to Slack by providing your own messaging
 class and overriding several methods. Here is one example:
 
 ```ruby
-module Slackistrano
-  class CustomMessaging < Messaging::Base
-
-    # Send failed message to #ops. Send all other messages to default channels.
-    # The #ops channel must exist prior.
-    def channels_for(action)
-      if action == :failed
-        "#ops"
-      else
-        super
-      end
-    end
-
-    # Suppress updating message.
-    def payload_for_updating
-      nil
-    end
-
-    # Suppress reverting message.
-    def payload_for_reverting
-      nil
-    end
-
-    # Fancy updated message.
-    # See https://api.slack.com/docs/message-attachments
-    def payload_for_updated
-      {
-        attachments: [{
-          color: 'good',
-          title: 'Integrations Application Deployed :boom::bangbang:',
-          fields: [{
-            title: 'Environment',
-            value: stage,
-            short: true
-          }, {
-            title: 'Branch',
-            value: branch,
-            short: true
-          }, {
-            title: 'Deployer',
-            value: deployer,
-            short: true
-          }, {
-            title: 'Time',
-            value: elapsed_time,
-            short: true
-          }],
-          fallback: super[:text]
-        }]
-      }
-    end
-
-    # Default reverted message.  Alternatively simply do not redefine this
-    # method.
-    def payload_for_reverted
-      super
-    end
-
-    # Slightly tweaked failed message.
-    # See https://api.slack.com/docs/message-formatting
-    def payload_for_failed
-      payload = super
-      payload[:text] = "OMG :fire: #{payload[:text]}"
-      payload
-    end
-
-    # Override the deployer helper to pull the full name from the password file.
-    # See https://github.com/phallstrom/slackistrano/blob/master/lib/slackistrano/messaging/helpers.rb
-    def deployer
-      Etc.getpwnam(ENV['USER']).gecos
-    end
-  end
+if defined?(Slackistrano::Messaging)
+   module Slackistrano
+     class CustomMessaging < Messaging::Base
+
+       # Send failed message to #ops. Send all other messages to default channels.
+       # The #ops channel must exist prior.
+       def channels_for(action)
+         if action == :failed
+           "#ops"
+         else
+           super
+         end
+       end
+
+       # Suppress updating message.
+       def payload_for_updating
+         nil
+       end
+
+       # Suppress reverting message.
+       def payload_for_reverting
+         nil
+       end
+
+       # Fancy updated message.
+       # See https://api.slack.com/docs/message-attachments
+       def payload_for_updated
+         {
+           attachments: [{
+             color: 'good',
+             title: 'Integrations Application Deployed :boom::bangbang:',
+             fields: [{
+               title: 'Environment',
+               value: stage,
+               short: true
+             }, {
+               title: 'Branch',
+               value: branch,
+               short: true
+             }, {
+               title: 'Deployer',
+               value: deployer,
+               short: true
+             }, {
+               title: 'Time',
+               value: elapsed_time,
+               short: true
+             }],
+             fallback: super[:text]
+           }]
+         }
+       end
+
+       # Default reverted message.  Alternatively simply do not redefine this
+       # method.
+       def payload_for_reverted
+         super
+       end
+
+       # Slightly tweaked failed message.
+       # See https://api.slack.com/docs/message-formatting
+       def payload_for_failed
+         payload = super
+         payload[:text] = "OMG :fire: #{payload[:text]}"
+         payload
+       end
+
+       # Override the deployer helper to pull the best name available (git, password file, env vars).
+       # See https://github.com/phallstrom/slackistrano/blob/master/lib/slackistrano/messaging/helpers.rb
+       def deployer
+         name = `git config user.name`.strip
+         name = nil if name.empty?
+         name ||= Etc.getpwnam(ENV['USER']).gecos || ENV['USER'] || ENV['USERNAME']
+         name
+       end
+     end
+   end
 end
 ```
 

data/lib/slackistrano/messaging/base.rb

@@ -10,14 +10,16 @@ module Slackistrano
       extend Forwardable
       def_delegators :env, :fetch
 
-      attr_reader :team, :token, :webhook
-
-      def initialize(env: nil, team: nil, channel: nil, token: nil, webhook: nil)
-        @env = env
-        @team = team
-        @channel = channel
-        @token = token
-        @webhook = webhook
+      attr_reader :team, :token, :webhook, :options
+
+      def initialize(options = {})
+        @options = options.dup
+
+        @env = options.delete(:env)
+        @team = options.delete(:team)
+        @channel = options.delete(:channel)
+        @token = options.delete(:token)
+        @webhook = options.delete(:webhook)
       end
 
       def payload_for_updating

data/lib/slackistrano/messaging/helpers.rb

@@ -3,15 +3,15 @@ module Slackistrano
     module Helpers
 
       def icon_url
-        'https://raw.githubusercontent.com/phallstrom/slackistrano/master/images/slackistrano.png'
+        options.fetch(:icon_url, 'https://raw.githubusercontent.com/phallstrom/slackistrano/master/images/slackistrano.png')
       end
 
       def icon_emoji
-        nil
+        options.fetch(:icon_emoji, nil)
       end
 
       def username
-        'Slackistrano'
+        options.fetch(:username, 'Slackistrano')
       end
 
       def deployer

data/lib/slackistrano/version.rb

@@ -1,3 +1,3 @@
 module Slackistrano
-  VERSION = '3.8.1'
+  VERSION = '3.8.2'
 end

data/spec/messaging/helpers_spec.rb

@@ -2,6 +2,39 @@ require 'spec_helper'
 
 describe Slackistrano::Messaging::Default do
 
+  describe "#icon_url" do
+    it "returns a default" do
+      expect(subject.icon_url).to match(/phallstrom.*slackistrano.png/)
+    end
+
+    it "returns a custom option" do
+      allow(subject).to receive(:options).and_return(icon_url: 'http://example.com/foo.png')
+      expect(subject.icon_url).to eq 'http://example.com/foo.png'
+    end
+  end
+
+  describe "#icon_emoji" do
+    it "returns a default of nil" do
+      expect(subject.icon_emoji).to eq nil
+    end
+
+    it "returns a custom option" do
+      allow(subject).to receive(:options).and_return(icon_emoji: ':thumbsup:')
+      expect(subject.icon_emoji).to eq ':thumbsup:'
+    end
+  end
+
+  describe "#username" do
+    it "returns a default" do
+      expect(subject.username).to eq 'Slackistrano'
+    end
+
+    it "returns a custom option" do
+      allow(subject).to receive(:options).and_return(username: 'Codan the Deployer')
+      expect(subject.username).to eq 'Codan the Deployer'
+    end
+  end
+
   describe '#branch' do
     it "delegates to fetch" do
       expect(subject).to receive(:fetch).with(:branch)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slackistrano
 version: !ruby/object:Gem::Version
-  version: 3.8.1
+  version: 3.8.2
 platform: ruby
 authors:
 - Philip Hallstrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano