mina-slack 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b72b29d455c89e9c3811ef1c5e7e2fdd3fc3a16b
+  data.tar.gz: f97e64fece874b64e56ce2b5b7bb5db96208b79e
+SHA512:
+  metadata.gz: f3e05095bc696693b8b29c3fa5e01a89242435af61cd3e5cf4ceaf9da01976f1e72e9f21f8229037075b5a382420dcbfe5b9abbd0f63a0681ad268a61502f8d9
+  data.tar.gz: 0ce8ddabcbf087e5c96247723a2058e466f9df0f525684406ddaabd53f7cf1829e8da1a756f04fd621aef5240a7e396cc2b045273609d1f02078bf07ddc9aac3

data/README.md

@@ -15,32 +15,41 @@ And then execute:
 Or install it yourself as:
 
     $ gem install mina-slack
-    
+
 In your slack settings, create new Incomming WebHooks and get WebHooks URL.
 
 ## Usage
 
-In `config/deploy.rb`
-
-```ruby
-require 'mina/slack/tasks'
-    
-# Set your WebHooks URL
-set :slack_hook_url, 'https://my.slack.com/services/hooks/incoming-webhook?token=token'
-# Set deployment env
-# default is value of settings.rails_env
-set :slack_env, 'production'
-    
-# Invoke slack task in your deploy task
-task :deploy do
-  deploy do
-    # some deploy commands...
-  end
-  invoke :'slack:finish'
-end
-```
-
-Notify text is `Finished deploy production` if you configure like above.
+### Load the recipe
+Include the recipe in your deploy.rb
+
+    # config/deploy.rb
+    require 'mina/slack'
+
+### Setup Slack Details
+You'll need to setup your slack details with an API key, room and subdomain. You can add these as ENV variables or in the config/deploy.rb
+
+    # required
+    set :slack_token, "webhook_token" # comes from inbound webhook integration
+    set :slack_room, "#general" # the room to send the message to
+    set :slack_subdomain, "example" # if your subdomain is example.slack.com
+
+    # optional
+    set :slack_application, "Application Name" # override Capistrano `application`
+    set :slack_username, "Deploy Bot" # displayed as name of message sender
+    set :slack_emoji, ":cloud:" # will be used as the avatar for the message
+
+Or use the ENV variables:
+
+    # required
+    ENV['SLACK_TOKEN'] = ''
+    ENV['SLACK_ROOM'] = ''
+    ENV['SLACK_SUBDOMAIN'] = ''
+
+    # optional
+    ENV['SLACK_APPLICATION'] = ''
+    ENV['SLACK_USERNAME'] = ''
+    ENV['SLACK_EMOJI'] = ''
 
 ## Contributing
 

data/lib/mina/slack.rb

@@ -1,5 +1,9 @@
 require "mina/slack/version"
 
+require 'mina/slack/defaults'
+require 'mina/slack/tasks'
+
+
 module Mina
   module Slack
   end

data/lib/mina/slack/defaults.rb

@@ -0,0 +1,12 @@
+# Required
+set_default :slack_token,       -> { ENV['SLACK_TOKEN'] }
+set_default :slack_room,        -> { ENV['SLACK_ROOM'] }
+set_default :slack_subdomain,   -> { ENV['SLACK_SUBDOMAIN'] }
+# Optional
+set_default :slack_stage,       -> { ENV['SLACK_STAGE'] || fetch(:rails_env, 'production') }
+set_default :slack_application, -> { ENV['SLACK_APPLICATION'] || application }
+set_default :slack_username,    -> { ENV['SLACK_USERNAME'] || 'deploybot' }
+set_default :slack_emoji,       -> { ENV['SLACK_EMOJI'] || ':cloud:' }
+# Git
+set_default :deployer,          -> { ENV['GIT_AUTHOR_NAME'] || %x[git config user.name].chomp }
+set_default :deployed_revision, -> { ENV['GIT_COMMIT'] || %x[git rev-parse #{branch}].strip }

data/lib/mina/slack/tasks.rb

@@ -1 +1,81 @@
-load File.expand_path("../tasks/mina-slack.rake", __FILE__)
+require 'mina/hooks'
+require 'json'
+require 'net/http'
+
+# Before and after hooks for mina deploy
+before_mina :deploy, :'slack:starting'
+after_mina :deploy, :'slack:finished'
+
+
+# Slack tasks
+namespace :slack do
+
+  task :starting do
+    if slack_token and slack_room and slack_subdomain
+      announcement = "#{announced_deployer} is deploying #{announced_application_name} to #{announced_stage}"
+
+      post_slack_message(announcement)
+      set(:start_time, Time.now)
+    else
+      print_local_status "Unable to create Slack Announcement, no slack details provided."
+    end
+  end
+
+  task :finished do
+    if slack_token and slack_room and slack_subdomain
+      end_time = Time.now
+      start_time = fetch(:start_time)
+      elapsed = end_time.to_i - start_time.to_i
+
+      announcement = "#{announced_deployer} successfully deployed #{announced_application_name} in #{elapsed} seconds."
+
+      post_slack_message(announcement)
+    else
+      print_local_status "Unable to create Slack Announcement, no slack details provided."
+    end
+  end
+
+
+  def announced_stage
+    ENV['to'] || rails_env || 'production'
+  end
+
+  def announced_deployer
+    deployer
+  end
+
+  def short_revision
+    deployed_revision[0..7] if deployed_revision
+  end
+
+  def announced_application_name
+    "".tap do |output|
+      output << slack_application if slack_application
+      output << " #{branch}" if branch
+      output << " (#{short_revision})" if short_revision
+    end
+  end
+
+  def post_slack_message(message)
+    # Parse the URI and handle the https connection
+    uri = URI.parse("https://#{slack_subdomain}.slack.com/services/hooks/incoming-webhook?token=#{slack_token}")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    payload = {
+      "parse"       => "full",
+      "channel"     => slack_room,
+      "username"    => slack_username,
+      "text"        => message,
+      "icon_emoji"  => slack_emoji
+    }
+
+    # Create the post request and setup the form data
+    request = Net::HTTP::Post.new(uri.request_uri)
+    request.set_form_data(:payload => payload.to_json)
+
+    # Make the actual request to the API
+    http.request(request)
+  end
+end

data/lib/mina/slack/version.rb

@@ -1,5 +1,5 @@
 module Mina
   module Slack
-    VERSION = "0.0.3"
+    VERSION = "0.1.0"
   end
 end

data/mina-slack.gemspec

@@ -6,8 +6,8 @@ require 'mina/slack/version'
 Gem::Specification.new do |spec|
   spec.name          = "mina-slack"
   spec.version       = Mina::Slack::VERSION
-  spec.authors       = ["TAKAyuki_atkwsk"]
-  spec.email         = ["takagi.takayuki.yuuki@gmail.com"]
+  spec.authors       = ["TAKAyuki_atkwsk", "Marcos G. Zimmermann"]
+  spec.email         = ["takagi.takayuki.yuuki@gmail.com", "mgzmaster@gmail.com"]
   spec.description   = %q{Slack web hook from mina}
   spec.summary       = %q{Slack web hook from mina}
   spec.homepage      = "https://github.com/TAKAyukiatkwsk/mina-slack"
@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_runtime_dependency 'rest-client', '~> 1.6.7'
-  spec.add_runtime_dependency 'mina', '~> 0.3.0'
+
+  spec.add_dependency "mina"
+  spec.add_dependency "mina-hooks"
 end

metadata

@@ -1,121 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: mina-slack
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - TAKAyuki_atkwsk
+- Marcos G. Zimmermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: rest-client
+  name: mina
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mina
+  name: mina-hooks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0'
 description: Slack web hook from mina
 email:
 - takagi.takayuki.yuuki@gmail.com
+- mgzmaster@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/mina/slack.rb
+- lib/mina/slack/defaults.rb
 - lib/mina/slack/tasks.rb
-- lib/mina/slack/tasks/mina-slack.rake
 - lib/mina/slack/version.rb
 - mina-slack.gemspec
 homepage: https://github.com/TAKAyukiatkwsk/mina-slack
 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'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Slack web hook from mina
 test_files: []
-has_rdoc: 

data/lib/mina/slack/tasks/mina-slack.rake

@@ -1,23 +0,0 @@
-require 'rest_client'
-require 'json'
-
-set_default :slack_hook_url, ''
-set_default :slack_payload_text, "Finished deploy"
-set_default :slack_env, ->{ rails_env }
-
-namespace :slack do
-  task :finish do
-    if slack_hook_url.empty?
-      error "Please `set :slack_hook_url`."
-      exit
-    end
-
-    if slack_payload_text.empty?
-      error "Please `set :slack_payload_text`."
-      exit
-    end
-
-    slack_payload = {text: "#{slack_payload_text} #{slack_env}"}
-    RestClient.post slack_hook_url, payload: slack_payload.to_json
-  end
-end