capistrano-slack_notification 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e72e1677f4f337d523465026ab43fea05f32d22
-  data.tar.gz: 12789f427d1f7aca2918d3cccef2577adb9d7eac
+  metadata.gz: 8b66e86a0a879cdff824b86b70a7815e65f2a15e
+  data.tar.gz: 3ecf96b8746375b1fc7ef8a4a60bb1ea82e78ec9
 SHA512:
-  metadata.gz: 4d1afca5522d9ac6cb2f97b7405ab6a645229163861d5aadea83b9124fa759d8b0cbd19ed9301be67f9690be0e358bbf1398ec55f7ecbda533c34907c7d3ef2a
-  data.tar.gz: 2f2abba849a4ac834e3294ff54eb9ac275c202ba436953d6cfc7faba8a440cb2bbed1b7545a12529b28da16a021c297422458f9b3a7d85831a6f7e5305d3ba7d
+  metadata.gz: ab8235df16b61cda6d4591dbc5fdb25e5e9f35a178f04744492f87c5cd8400ada4cb7aa4ffe403cf955ba487e36daf3cb69e91a5cc7c5c04acba9cf70c6105c8
+  data.tar.gz: 8caac8579ce6fb0ac1333e6ff45f1499634d41210f713ddf9a107d36c3799931b7003b002e946fc7eb2b6ef5859d046f0c1d8a38b6d2be786b20c09f22e7fa65

data/README.md

@@ -30,13 +30,15 @@ $ gem install capistrano-slack_notification
 Usage
 -----
 
-Capfile:
+### Capfile
 
 ```ruby
 require 'capistrano/slack_notification'
 ```
 
-config.rb:
+### config/deploy.rb
+
+if use webhook
 
 ```ruby
 set :slack_channel, '#general'
@@ -48,6 +50,22 @@ after 'deploy:finishing', 'slack:deploy:finish'
 after 'deploy:finishing_rollback', 'slack:deploy:rollback'
 ```
 
+if use api that needs channel_id
+
+```sh
+$ cap production "slack:channel[general]"
+#general: C038M2LE1
+```
+
+```ruby
+set :slack_channel, 'C038M2LE1'
+set :slack_token, 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+
+after 'deploy:started', 'slack:deploy:start'
+after 'deploy:finishing', 'slack:deploy:finish'
+after 'deploy:finishing_rollback', 'slack:deploy:rollback'
+```
+
 Contributing
 ------------
 

data/lib/capistrano/slack_notification/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module SlackNotification
-    VERSION = '0.0.7'
+    VERSION = '0.1.0'
   end
 end

data/lib/capistrano/tasks/slack_notification.rake

@@ -18,11 +18,16 @@ namespace :slack do
     username
   }
 
-  set :slack_path, -> {
-    token = fetch(:slack_token)
-    "/api/chat.postMessage#{"?token=#{token}" if token}"
+  set :slack_post_message_api_endpoint, -> {
+    "/api/chat.postMessage?token=#{fetch(:slack_token)}"
   }
 
+  set :slack_channel_list_api_endpoint, -> {
+    "/api/channels.list?exclude_archived=1&token=#{fetch(:slack_token)}"
+  }
+
+  set :slack_path, -> { fetch(:slack_post_message_api_endpoint) }
+
   set :slack_stage, -> {
     stage = fetch(:stage)
     stage.to_s == 'production' ? ":warning: #{stage}" : stage
@@ -41,7 +46,7 @@ namespace :slack do
 
   set :slack_start_body, -> {
     text = "Started deploying to #{fetch(:slack_stage)} by @#{fetch(:slack_deployer)}" +
-      " (branch #{fetch(:branch)})",
+      " (branch #{fetch(:branch)})"
 
     fetch(:slack_default_body).merge(
       attachments: JSON.dump([{
@@ -85,24 +90,22 @@ namespace :slack do
     )
   }
 
-  def post_to_slack(message = '')
-    post_to_slack_with fetch(:slack_default_body).merge(text: message)
-  end
+  set :slack_client, -> {
+    Faraday.new(fetch :slack_endpoint) do |c|
+      c.request :url_encoded
+      c.adapter Faraday.default_adapter
 
-  def post_to_slack_with(body)
-    run_locally do
-      conn = Faraday.new(fetch :slack_endpoint) do |c|
-        c.request :url_encoded
-        c.adapter Faraday.default_adapter
-
-        v = Faraday::VERSION.split('.')
-        if v.join('.').to_f >= 0.9
-          c.options.timeout = 5
-          c.options.open_timeout = 5
-        end
+      v = Faraday::VERSION.split('.')
+      if v.join('.').to_f >= 0.9
+        c.options.timeout = 5
+        c.options.open_timeout = 5
       end
+    end
+  }
 
-      res = conn.post fetch(:slack_path), body
+  def post_to_slack_with(body)
+    run_locally do
+      res = fetch(:slack_client).post fetch(:slack_path), body
 
       if ENV['DEBUG']
         require 'awesome_print'
@@ -114,7 +117,17 @@ namespace :slack do
 
   desc 'Post message to Slack (ex. cap production "slack:notify[yo!])"'
   task :post, :message do |t, args|
-    post_to_slack args[:message]
+    post_to_slack_with fetch(:slack_default_body).merge(text: args[:message])
+  end
+
+  desc 'Get channel ID by channel name from Slack (ex. cap production "slack:channel[general])"'
+  task :channel, :channel_name do |t, args|
+    run_locally do
+      res = fetch(:slack_client).post fetch(:slack_channel_list_api_endpoint)
+      body = JSON.load(res.body)
+      channel = body['channels'].find { |ch| ch['name'] == args[:channel_name] }
+      puts "##{args[:channel_name]}: #{channel['id']}"
+    end
   end
 
   namespace :deploy do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-slack_notification
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - linyows