capistrano-hook 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b80c4faf5076514a2e20ceb5a515f973934c0e952102807233d03f31eac28a42
-  data.tar.gz: a0c638091a9edad6c551fdf4e412ed262e1279b8c9010b5fc0caf2cffcc83696
+  metadata.gz: 99bc36d1c0f7464499165ef8406b0b28a13c58410c7c9f7aabd566c17550339a
+  data.tar.gz: a3f5b8ab947dada284400bbe0e09596ca3cb3b07649c8a5bceef9fad2845b4bf
 SHA512:
-  metadata.gz: 065e963486d4e78e1efcc71fd14f77e1e003634d9ddb845a98d64aca9b666b4d2074e1f673550deadc8214c570c5643dd7e89b418a5d3969d96b0e4da1062363
-  data.tar.gz: 88fe744384f7d9fee5ce19a16cec95509743163ab92f9115fb53a644e264e8c065ef73cb184357b03820904487e323d37f8dc0fc66a73f8947f2798ce557a20c
+  metadata.gz: f242724c1176a34f71b0000456d4d813d62c63f7f67799bc02b4650f2e60d9dd4a358f0c376a585ae69f252b67372ed1a55b57c667c7d971b841ba698dac7021
+  data.tar.gz: 8addfb5040dbd8ecdefea9c25eb06fbf28b0d77172a0f02321f893633789c68ca0abb456d143822eb8948361d55ade6dbde990fd4c14d1c5bbfc27c25a3218ca

data/.rubocop.yml

@@ -1,12 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
 Metrics/BlockLength:
-  Max: 76
+  Max: 100
 
 Metrics/LineLength:
-  Max: 104
+  Max: 160
 
 Style/Documentation:
   Enabled: false
 
-Style/SpaceBeforeFirstArg:
+Layout/SpaceBeforeFirstArg:
   Enabled: false
-

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-05-26 17:01:17 +0000 using RuboCop version 0.75.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 rvm:
   - 2.3.8
-  - 2.4.7
-  - 2.5.6
-  - 2.6.4
-before_install: gem install bundler -v 1.12.5
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4
 script:
   - bundle exec rake
   - bundle exec rubocop

data/Capfile

@@ -2,6 +2,8 @@
 
 require 'capistrano/setup'
 require 'capistrano/deploy'
+require 'capistrano/scm/git'
 require 'capistrano/hook'
 
+install_plugin Capistrano::SCM::Git
 # Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

data/bin/setup

@@ -2,6 +2,10 @@
 set -euo pipefail
 IFS=$'\n\t'
 
+VERSION=$(ruby -e "require './lib/capistrano/hook/version'; print Capistrano::Hook::VERSION")
+
 bundle install
+bundle exec rake build
+gem install pkg/capistrano-hook-${VERSION}.gem
 
 # Do any other automated setup that you need to do here

data/capistrano-hook.gemspec

@@ -15,7 +15,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/yulii/capistrano-hook'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -25,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'minitest-reporters'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock'
 end

data/config/deploy.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 # config valid only for current version of Capistrano
-lock '3.4.0'
+# lock '3.4.0'
 
 set :application, 'capistrano-hook'
 set :repo_url, 'git@github.com:yulii/capistrano-hook.git'
 set :branch, :master
 
 set :deploy_to, '/tmp'
-set :scm, :git
 set :format, :pretty
 set :log_level, :debug
 

data/config/deploy/{staging.rb → all.rb}

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # server-based syntax
 # ======================
 # Defines a single server with a list of roles and multiple properties.
@@ -22,26 +23,14 @@
 
 # Configuration
 # =============
-# You can set any configuration variable like in config/deploy.rb
-# These variables are then only loaded and set in this stage.
-# For available Capistrano configuration variables see the documentation page.
-# http://capistranorb.com/documentation/getting-started/configuration/
-# Feel free to add new variables to customise your setup.
+set :webhook_url, ENV.fetch('WEBHOOK_URL') { MOCK_URL[(ENV['STATUS_CODE'] || '200')] }
+set :webhook_http_headers, 'Content-Type' => 'application/x-www-form-urlencoded'
+set :webhook_starting_payload,   params: '[production] Now, deploying...'
+set :webhook_finished_payload,   params: '[production] Deployment has been completed!'
+set :webhook_failed_payload,     params: '[production] Oops! something went wrong.'
+set :webhook_reverting_payload,  params: '[production] Reverting...'
+set :webhook_rollbacked_payload, params: '[production] Rollback has been completed!'
 
-# Custom SSH Options
-# ==================
-# You may pass any option but keep in mind that net/ssh understands a
-# limited set of options, consult the Net::SSH documentation.
-# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
-#
-# Global options
-# --------------
-#  set :ssh_options, {
-#    keys: %w(/home/rlisowski/.ssh/id_rsa),
-#    forward_agent: false,
-#    auth_methods: %w(password)
-#  }
-#
 # The server-based syntax can be used to override options:
 # ------------------------------------
 # server 'example.com',

data/config/deploy/discord.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# server-based syntax
+# ======================
+# Defines a single server with a list of roles and multiple properties.
+# You can define all roles on a single server, or split them:
+
+# server 'example.com', user: 'deploy', roles: %w{app db web}, my_property: :my_value
+# server 'example.com', user: 'deploy', roles: %w{app web}, other_property: :other_value
+# server 'db.example.com', user: 'deploy', roles: %w{db}
+
+# role-based syntax
+# ==================
+
+# Defines a role with one or multiple servers. The primary server in each
+# group is considered to be the first unless any  hosts have the primary
+# property set. Specify the username and a domain or IP for the server.
+# Don't use `:all`, it's a meta role.
+
+# role :app, %w{deploy@example.com}, my_property: :my_value
+# role :web, %w{user1@primary.com user2@additional.com}, other_property: :other_value
+# role :db,  %w{deploy@example.com}
+
+# Configuration
+# =============
+set :webhook_url, ENV.fetch('WEBHOOK_URL') { MOCK_URL[(ENV['STATUS_CODE'] || '200')] }
+set :webhook_starting_payload,   content: '[production] Now, deploying...'
+set :webhook_finished_payload,   content: '[production] Deployment has been completed!'
+set :webhook_failed_payload,     content: '[production] Oops! something went wrong.'
+set :webhook_reverting_payload,  content: '[production] Reverting...'
+set :webhook_rollbacked_payload, content: '[production] Rollback has been completed!'
+
+# The server-based syntax can be used to override options:
+# ------------------------------------
+# server 'example.com',
+#   user: 'user_name',
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: 'user_name', # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: 'please use keys'
+#   }

data/config/deploy/{production.rb → slack.rb}

@@ -23,7 +23,7 @@
 
 # Configuration
 # =============
-set :webhook_url, MOCK_URL[(ENV['STATUS_CODE'] || '200')]
+set :webhook_url, ENV.fetch('WEBHOOK_URL') { MOCK_URL[(ENV['STATUS_CODE'] || '200')] }
 set :webhook_starting_payload,   text: '[production] Now, deploying...'
 set :webhook_finished_payload,   text: '[production] Deployment has been completed!'
 set :webhook_failed_payload,     text: '[production] Oops! something went wrong.'

data/lib/capistrano/hook/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Hook
-    VERSION = '0.3.4'
+    VERSION = '0.4.0'
   end
 end

data/lib/capistrano/hook/web.rb

@@ -5,34 +5,49 @@ require 'net/http'
 module Capistrano
   module Hook
     class Web
+      attr_reader :uri, :http, :request, :headers
       private_class_method :new
 
-      def initialize(url)
-        @uri  = URI.parse(url).freeze
-        @http = Net::HTTP.new(@uri.host, @uri.port)
-        @http.use_ssl = @uri.is_a?(URI::HTTPS)
+      def initialize(url, headers)
+        @uri     = URI.parse(url).freeze
+        @headers = headers
+        initialize_http
+        initialize_request
       end
 
       def post(params)
-        # TODO: rescue / logger
         http.start do
-          http.request(request(params))
+          request.body = params.to_json
+          http.request(request)
         end
       end
 
-      def request(params)
-        Net::HTTP::Post.new(uri.path).tap do |o|
-          o.set_form_data(payload: params.to_json)
-        end
+      def self.client(url, headers = {})
+        new(url, headers.is_a?(Hash) ? headers : {})
       end
 
-      def self.client(url)
-        new(url)
+      private
+
+      def path
+        return '/' if uri.path.nil?
+        return '/' if uri.path.empty?
+
+        uri.path
       end
 
-      protected
+      def default_headers
+        { 'Content-Type' => 'application/json' }
+      end
 
-      attr_reader :uri, :http
+      def initialize_http
+        @http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.is_a?(URI::HTTPS)
+      end
+
+      def initialize_request
+        @request = Net::HTTP::Post.new(path)
+        request.initialize_http_header(default_headers.merge(headers))
+      end
     end
   end
 end

data/lib/capistrano/tasks/webhook.rake

@@ -12,11 +12,11 @@
 #    set :webhook_rollbacked_payload, { text: 'Rollback has been completed!' }
 
 namespace :webhook do
-  def webhook(url, payload)
+  def webhook(url, payload, headers = {})
     return if url.nil? || payload.nil? || payload.empty?
 
     info "POST #{url} payload='#{payload}'"
-    result = Capistrano::Hook::Web.client(url).post(payload)
+    result = Capistrano::Hook::Web.client(url, headers).post(payload)
     message = "HTTP #{result.code} #{result.message} body='#{result.body}'; "
     if result.is_a?(Net::HTTPSuccess)
       info message
@@ -30,6 +30,7 @@ namespace :webhook do
     task :list do
       run_locally do
         keys = %i[webhook_url
+                  webhook_http_headers
                   webhook_starting_payload
                   webhook_finished_payload
                   webhook_failed_payload
@@ -51,7 +52,8 @@ namespace :webhook do
       run_locally do
         url     = fetch(:webhook_url)
         payload = fetch(:webhook_starting_payload)
-        webhook(url, payload)
+        headers = fetch(:webhook_http_headers)
+        webhook(url, payload, headers)
       end
     end
 
@@ -60,7 +62,8 @@ namespace :webhook do
       run_locally do
         url     = fetch(:webhook_url)
         payload = fetch(:webhook_finished_payload)
-        webhook(url, payload)
+        headers = fetch(:webhook_http_headers)
+        webhook(url, payload, headers)
       end
     end
 
@@ -69,7 +72,8 @@ namespace :webhook do
       run_locally do
         url     = fetch(:webhook_url)
         payload = fetch(:webhook_failed_payload)
-        webhook(url, payload)
+        headers = fetch(:webhook_http_headers)
+        webhook(url, payload, headers)
       end
     end
 
@@ -78,7 +82,8 @@ namespace :webhook do
       run_locally do
         url     = fetch(:webhook_url)
         payload = fetch(:webhook_reverting_payload)
-        webhook(url, payload)
+        headers = fetch(:webhook_http_headers)
+        webhook(url, payload, headers)
       end
     end
 
@@ -87,7 +92,8 @@ namespace :webhook do
       run_locally do
         url     = fetch(:webhook_url)
         payload = fetch(:webhook_rollbacked_payload)
-        webhook(url, payload)
+        headers = fetch(:webhook_http_headers)
+        webhook(url, payload, headers)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-hook
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - yulii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -70,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Notification hooks include start, finish and fail of deployments.
 email:
 - yone.info@gmail.com
@@ -103,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Capfile
@@ -116,8 +131,9 @@ files:
 - bin/test
 - capistrano-hook.gemspec
 - config/deploy.rb
-- config/deploy/production.rb
-- config/deploy/staging.rb
+- config/deploy/all.rb
+- config/deploy/discord.rb
+- config/deploy/slack.rb
 - lib/capistrano/hook.rb
 - lib/capistrano/hook/load.rb
 - lib/capistrano/hook/version.rb