capistrano-slackify 1.0.0 → 1.1.0

data/README.md

@@ -1,4 +1,4 @@
-# Capistrano Slackify
+# Capistrano Slackify [![Build Status](https://travis-ci.org/onthebeach/capistrano-slackify.svg)](https://travis-ci.org/onthebeach/capistrano-slackify)
 
 Publish deploy notifications to [Slack](https://slack.com) - for [Capistrano v3](https://github.com/capistrano/capistrano).
 
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 Require the gem in your `Capfile`:
 
-    require 'capistrano/slackfiy'
+    require 'capistrano/slackify'
 
 And then set the required variables in `config/deploy.rb`:
 
@@ -35,7 +35,7 @@ The task will run automatically on deploy, or can be run manually using:
 
 By default, this will publish something along the lines of:
 
-    Revision 64a3c1de of my_app deployed to production by seenmyfate
+    Revision 64a3c1de of my_app deployed to production by seenmyfate in 333 seconds.
 
 ###  Customisation
 
@@ -43,8 +43,16 @@ Any of the defaults can be over-ridden in `config/deploy.rb`:
 
     set :slack_channel, '#devops'
     set :slack_username, 'Deploybot'
-    set :slack_text, -> { "Uh-oh, #{local_user} just deployed" }
     set :slack_emoji, ':trollface:'
+    set :slack_user, ENV['GIT_AUTHOR_NAME']
+    set :slack_text, -> {
+      "Revision #{fetch(:current_revision, fetch(:branch))} of " \
+      "#{fetch(:application)} deployed to #{fetch(:stage)} by #{local_user} " \
+      "in #{elapsed} seconds."
+    }
+    set :slack_deploy_starting_text, -> {  
+      "Notifying Slack of #{fetch(:stage)} deploy starting with revision/branch #{fetch(:current_revision, fetch(:branch))} for #{fetch(:application)}"
+    }
 
 ### 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       = '1.0.0'
+  spec.version       = '1.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

@@ -1,25 +1,46 @@
 namespace :slack do
   desc 'Notify Slack of a deployment via the incoming webhooks integration - ' \
        ':slack_subdomain and :slack_token must be set'
-  task :notify do
+  task :notify_started do
     run_locally do
-      info 'Notifying Slack of deploy'
+      info 'Notifying Slack of deploy starting'
+      set :time_started, Time.now.to_i
       execute :curl, '-X POST',
-        '--data-urlencode', fetch(:slack_payload),
+        '--data-urlencode', Slackify::Payload.build(:start),
         fetch(:slack_url)
     end
   end
+  before 'deploy', 'slack:notify_started'
 
-  after 'deploy:finished', 'slack:notify'
+  desc 'Notify Slack of a deployment via the incoming webhooks integration - ' \
+       ':slack_subdomain and :slack_token must be set'
+  task :notify_finished 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(:finish),
+        fetch(:slack_url)
+    end
+  end
+  after 'deploy:finished', 'slack:notify_finished'
 end
 
 namespace :load do
   task :defaults do
     set :slack_channel, '#general'
     set :slack_username, 'Capistrano'
-    set :slack_text, -> { slack_text }
     set :slack_emoji, ':ghost:'
-    set :slack_payload, -> { "'payload=#{slack_payload}'" }
-    set :slack_url, -> { slack_url }
+    set :slack_user, -> { local_user.strip }
+    set :slack_url, -> { Slackify::Configuration.instance.url }
+    set :slack_text, lambda {
+      time_elapsed = Integer(fetch(:time_finished) - fetch(:time_started))
+      "Revision #{fetch(:current_revision, fetch(:branch))} of " \
+      "#{fetch(:application)} deployed to #{fetch(:stage)} by #{fetch(:slack_user)} " \
+      "in #{time_elapsed} seconds." 
+    }
+    set :slack_deploy_starting_text, -> {  
+      "#{fetch(:stage)} deploy starting with revision/branch #{fetch(:current_revision, fetch(:branch))} for #{fetch(:application)}"
+    }
   end
 end

data/lib/slackify.rb

@@ -1,9 +1,9 @@
 require 'uri'
 require 'yajl/json_gem'
-module Slackify
+require 'singleton'
 
+module Slackify
   class URL
-
     def initialize(subdomain, token)
       @subdomain, @token = subdomain, token
     end
@@ -21,34 +21,57 @@ module Slackify
     end
   end
 
-  module Payload
+  class Payload
+
+    attr_reader :status
+    protected :status
+
+    def self.build(status)
+      new(status).build
+    end
+
+    def initialize(status)
+      @status = status
+    end
+
+    def build
+      "'payload=#{payload}'"
+    end
 
-    def slack_payload
+    def payload
       {
         channel: fetch(:slack_channel),
         username: fetch(:slack_username),
-        text: fetch(:slack_text),
+        text: slack_text,
         icon_emoji: fetch(:slack_emoji)
       }.to_json
     end
 
     def slack_text
-      "Revision #{fetch(:current_revision, fetch(:branch))} of " \
-        "#{fetch(:application)} deployed to #{fetch(:stage)} by #{local_user}"
+      if @status == :start
+        fetch(:slack_deploy_starting_text)
+      else
+        fetch(:slack_text)
+      end
     end
 
-    def slack_url
-      URL.new(slack_subdomain, slack_token).to_s
+  end
+
+  class Configuration
+    include Singleton
+
+    def url
+      URL.new(subdomain, token).to_s
     end
 
-    def slack_subdomain
+    private
+
+    def subdomain
       fetch(:slack_subdomain) { fail ':slack_subdomain is not set' }
     end
 
-    def slack_token
+    def token
       fetch(:slack_token) { fail ':slack_token is not set' }
     end
-
   end
 end
-self.extend(Slackify::Payload)

metadata

@@ -1,83 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-slackify
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
+  prerelease: 
 platform: ruby
 authors:
 - seenmyfate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Publish deployment notifications to Slack via the incoming webhooks integration
@@ -87,8 +98,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -103,28 +114,34 @@ files:
 homepage: https://github.com/onthebeach/capistrano-slackify
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3771920176072130592
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3771920176072130592
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Publish deployment notifications to Slack via the incoming webhooks integration
 test_files:
 - spec/lib/slackify_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 7f43d21b28dc2237a8c389c9925bde9e9f96947e
-  data.tar.gz: 8ca460ea89937d3b18074e6faea7a7d7280adda2
-SHA512:
-  metadata.gz: 95447efe53eb4ad20865629e3d800e93cea36c20242b849c4e62f54d2a994c7bdf5f22a61c23f211508dcdc6a49cf339d95f354bfa9ad6b99695322daa20fbeb
-  data.tar.gz: 46a2a7625fbee81dd9f677f97d4830d9eb96b528a72b11ca8fda0e11ccccaf9f55fc19f3539c1c46a89e0b93305364e36cb534b6fe8bbf2f1272039dc5dabf06