capistrano-hook 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6734a63af83178f4c7b8199305e4a70aa5e4f31
-  data.tar.gz: c4b53ab0c45b1874b7b2a9d7283404626407f1a4
+  metadata.gz: 9e5f778e0764d7fe69d8750bab671b06838bc931
+  data.tar.gz: b485c2534e1d2d94fc80a7f426c9fab725ccda42
 SHA512:
-  metadata.gz: 4621f0f1b45015a06115978e31ce8333871db88fae44ad8f59ff40efce5adc516d5aa86c7357ad237abdf2d17e9c8d46a1a3c9fb3a60b59d1eeec8697217f378
-  data.tar.gz: 44be5d2351f624f3314638837899e3806bb66ee83a8c06ec5245ff3283332ff8bf9de264eec3cbcc3abb634087fca346efdd645d23f33ed0dd2b8ec8b90478ee
+  metadata.gz: c2949d100809fa35d82bfb433558920b4673a20002bdb7a48541689aed549843791cdba36b8b117a94e1902185b67b13a05cd27b554384c66a72d28aecf1e111
+  data.tar.gz: 8b652526794b49792f82c3bf43ec0777a21de3b4fab1b3d6b36a5fa989b53614c175ddb8534aa1ab17ce0df2fe68e0ee8fb99ea2ffc2a209328135cbf4495bf0

data/.travis.yml

@@ -1,16 +1,14 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2.2
+  - 2.2.3
   - ruby-head
-  - jruby-19mode
   - rbx-2
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-19mode
     - rvm: rbx-2
 before_install: gem install bundler -v 1.10.5
 script:

data/README.md

@@ -1,12 +1,19 @@
 # Capistrano::Hook
 
 [![Gem Version](https://badge.fury.io/rb/capistrano-hook.svg)](http://badge.fury.io/rb/capistrano-hook)
-[![Build Status](https://travis-ci.org/yulii/capistrano-hook.svg)](https://travis-ci.org/yulii/capistrano-hook)
+[![Build Status](https://travis-ci.org/yulii/capistrano-hook.svg?branch=master)](https://travis-ci.org/yulii/capistrano-hook)
 [![Code Climate](https://codeclimate.com/github/yulii/capistrano-hook/badges/gpa.svg)](https://codeclimate.com/github/yulii/capistrano-hook)
 [![Dependency Status](https://gemnasium.com/yulii/capistrano-hook.svg)](https://gemnasium.com/yulii/capistrano-hook)
 
 Notification hooks include start, finish and fail of deployments.
 
+## Features
+
+### Webhoook
+
+Notify Capistrano deployments via webhook API.
+Just set the webhook URL and message.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,7 +30,9 @@ Add this line to your Capfile:
 require 'capistrano/hook'
 ```
 
-Capistrano hook will not be run with no settings. You can setting the variables shown below.
+### Webhook
+
+Webhook will not be run with no settings. You can setting the variables shown below.
 
 ```ruby
 set :webhook_url, 'https://yulii.github.io/services'
@@ -34,15 +43,29 @@ set :webhook_reverting_payload,  { text: 'Reverting...' }
 set :webhook_rollbacked_payload, { text: 'Rollback has been completed!' }
 ```
 
+### Testing
+
 Test your setup by running:
+
 ```
-cap production webhook:post:starting
-cap production webhook:post:finished
-cap production webhook:post:failed
-cap production webhook:post:reverting
-cap production webhook:post:rollbacked
-```
+# List the webhook configured variables
+$ cap production webhook:config:list
+
+# Post a starting message
+$ cap production webhook:post:starting
+
+# Post a finished message
+$ cap production webhook:post:finished
 
+# Post a failed message
+$ cap production webhook:post:failed
+
+# Post a reverting message
+$ cap production webhook:post:reverting
+
+# Post a rollbacked message
+$ cap production webhook:post:rollbacked
+```
 
 ### Slack
 

data/lib/capistrano/hook/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Hook
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.3.2'.freeze
   end
 end

data/lib/capistrano/hook/web.rb

@@ -13,9 +13,13 @@ module Capistrano
       def post(params)
         # TODO: rescue / logger
         http.start do
-          request = Net::HTTP::Post.new(uri.path)
-          request.set_form_data(payload: params.to_json)
-          http.request(request)
+          http.request(request(params))
+        end
+      end
+
+      def request(params)
+        Net::HTTP::Post.new(uri.path).tap do |o|
+          o.set_form_data(payload: params.to_json)
         end
       end
 

data/lib/capistrano/tasks/webhook.rake

@@ -1,18 +1,15 @@
-namespace :webhook do
-  desc <<-DESC
-    Capistrano hook will not be run with no settings.
-
-    You can setting the variables shown below.
-
-      set :webhook_url, 'https://yulii.github.io'
-      set :webhook_starting_payload,   { text: 'Now, deploying...' }
-      set :webhook_finished_payload,   { text: 'Deployment has been completed!' }
-      set :webhook_failed_payload,     { text: 'Oops! something went wrong.' }
-      set :webhook_reverting_payload,  { text: 'Reverting...' }
-      set :webhook_rollbacked_payload, { text: 'Rollback has been completed!' }
-
-  DESC
+#  Capistrano hook will not be run with no settings.
+#
+#  You can setting the variables shown below.
+#
+#    set :webhook_url, 'https://yulii.github.io'
+#    set :webhook_starting_payload,   { text: 'Now, deploying...' }
+#    set :webhook_finished_payload,   { text: 'Deployment has been completed!' }
+#    set :webhook_failed_payload,     { text: 'Oops! something went wrong.' }
+#    set :webhook_reverting_payload,  { text: 'Reverting...' }
+#    set :webhook_rollbacked_payload, { text: 'Rollback has been completed!' }
 
+namespace :webhook do
   def webhook(url, payload)
     return if url.nil? || payload.nil? || payload.empty?
     info "POST #{url} payload='#{payload}'"
@@ -25,7 +22,28 @@ namespace :webhook do
     end
   end
 
+  namespace :config do
+    desc 'List the webhook configured variables'
+    task :list do
+      run_locally do
+        keys = [:webhook_url,
+                :webhook_starting_payload,
+                :webhook_finished_payload,
+                :webhook_failed_payload,
+                :webhook_reverting_payload,
+                :webhook_rollbacked_payload
+               ].sort
+        padding = keys.max { |a, b| a.length <=> b.length }.length
+        keys.each do |key|
+          next if fetch(key).nil? || fetch(key).empty?
+          puts ":#{key.to_s.ljust(padding)} => #{fetch(key)}"
+        end
+      end
+    end
+  end
+
   namespace :post do
+    desc 'Post a starting message if :webhook_url and :webhook_starting_payload are present'
     task :starting do
       run_locally do
         url     = fetch(:webhook_url)
@@ -34,6 +52,7 @@ namespace :webhook do
       end
     end
 
+    desc 'Post a finished message if :webhook_url and :webhook_finished_payload are present'
     task :finished do
       run_locally do
         url     = fetch(:webhook_url)
@@ -42,6 +61,7 @@ namespace :webhook do
       end
     end
 
+    desc 'Post a failed message if :webhook_url and :webhook_failed_payload are present'
     task :failed do
       run_locally do
         url     = fetch(:webhook_url)
@@ -50,6 +70,7 @@ namespace :webhook do
       end
     end
 
+    desc 'Post a reverting message if :webhook_url and :webhook_reverting_payload are present'
     task :reverting do
       run_locally do
         url     = fetch(:webhook_url)
@@ -58,6 +79,7 @@ namespace :webhook do
       end
     end
 
+    desc 'Post a rollbacked message if :webhook_url and :webhook_rollbacked_payload are present'
     task :rollbacked do
       run_locally do
         url     = fetch(:webhook_url)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-hook
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - yulii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano