capistrano-deploy_hooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eef0dba2366fd955fe2910134db796ef5ef10a03
+  data.tar.gz: c8efd9a22fcfa713509f5e7349691298896cdf95
+SHA512:
+  metadata.gz: f3f2ae079d008c472b72fb9b3bb4c3cc73a6db806c2b0d53fb60d053a933dc80769b509a5238aafe6d15c3edd4017dcce260b74fa4e0c9f65d85ab851364a47b
+  data.tar.gz: 400bf8e27d8406cb7d75de8deebf3461e5b8f24dc175f872d584df0911cd0dc6047b66ead83651a107855e42f466bc06d8cddf4f990c0ce160c6380727b4c58f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-deploy_hooks.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# Capistrano::DeployHooks
+
+This is a small framework for generating webhooks for the various stages of a Capistrano deploy. It comes with some messengers prepacked, for example Mattermost.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-deploy_hooks'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In your Capfile:
+
+```ruby
+require 'capistrano/deploy_hooks'
+```
+
+In your Capistrano config:
+
+```ruby
+# or another messenger from somewhere
+require 'capistrano/deploy_hooks/messengers/mattermost'
+
+if ENV['WEBHOOK_URI']
+  set :deploy_hooks, {
+    messenger: Capistrano::DeployHooks::Messengers::Mattermost,
+    webhook_uri: ENV['WEBHOOK_URI'],
+  }
+end
+```
+
+## Messengers
+
+Messengers should respond to `payload_for(action)`, and return Hash 'payloads', with the following optional actions: updating, reverting, updated, reverted, failed. They should also respond to `webhook_for(action)` and return a URI to post the webhook to. See `capistrano/deploy_hooks/messengers/mattermost.rb` as an example of this. Messengers are initialized with the hash config passed to capistrano's `set :deploy_hooks` call.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-mattermost.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/deploy_hooks"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-deploy_hooks.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/deploy_hooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-deploy_hooks"
+  spec.version       = Capistrano::DeployHooks::VERSION
+  spec.authors       = ["Mike Campbell"]
+  spec.email         = ["mike.campbell@meritec.co.uk"]
+
+  spec.summary       = %q{Configurable deploy hooks for Capistrano}
+  spec.homepage      = "https://www.github.com/meritec/capistrano-deploy_hooks"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", ">= 3.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/capistrano/deploy_hooks/main.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module Capistrano
+  module DeployHooks
+    class Main
+      extend Forwardable
+      def_delegators :@cap, :fetch, :run_locally
+
+      def initialize(cap)
+        @env = cap
+        opts = fetch(:deploy_hooks, {}).dup
+
+        @messenger = opts.delete(:messenger).new(cap, opts)
+      end
+
+      def run(action)
+        _self = self
+        run_locally{ _self.process(action) }
+      end
+
+      def process(action)
+        uri = URI(@messenger.webhook_for(action))
+        @messenger.payloads_for(action).each do |payload|
+          Net::HTTP.post_form(uri, { 'payload' => payload.to_json })
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/deploy_hooks/messengers/mattermost.rb

@@ -0,0 +1,70 @@
+module Capistrano
+  module DeployHooks
+    module Messengers
+      class Mattermost
+        extend Forwardable
+        def_delegators :@cap, :fetch
+
+        attr_reader :opts
+
+        def initialize(cap, opts)
+          @cap  = cap
+          @opts = opts
+        end
+
+        def payloads_for(action)
+          method = "payload_for_#{action}"
+          return if !respond_to?(method)
+
+          pl = (opts[:payload] || {}).merge(username: "Capistrano").merge(send(method))
+
+          channels = Array(opts[:channels])
+
+          payloads = channels.map{ |c| pl.merge(channel: c) }
+          payloads = [pl] if payloads.empty?
+          payloads
+        end
+
+        def payload_for_updating
+          { text: "#{deployer} has started deploying branch #{branch} of #{application} to #{stage}" }
+        end
+
+        def payload_for_reverting
+          { text: "#{deployer} has started rolling back branch #{branch} of #{application} to #{stage}" }
+        end
+
+        def payload_for_updated
+          { text: "#{deployer} has finished deploying branch #{branch} of #{application} to #{stage}" }
+        end
+
+        def payload_for_reverted
+          { text: "#{deployer} has finished rolling back branch of #{application} to #{stage}" }
+        end
+
+        def payload_for_failed
+          { text: "#{deployer} has failed to #{deploying? ? 'deploy' : 'rollback'} branch #{branch} of #{application} to #{stage}" }
+        end
+
+        def webhook_for(_)
+          opts[:webhook_uri]
+        end
+
+        def deployer
+          ENV["USER"] || ENV["USERNAME"]
+        end
+
+        def branch
+          fetch(:branch)
+        end
+
+        def application
+          fetch(:application)
+        end
+
+        def stage
+          fetch(:stage, '')
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/deploy_hooks/tasks.rb

@@ -0,0 +1,2 @@
+require 'capistrano/deploy_hooks/main'
+load File.expand_path("../../tasks/deploy_hooks.rake", __FILE__)

data/lib/capistrano/deploy_hooks/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module DeployHooks
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/deploy_hooks.rb

@@ -0,0 +1,2 @@
+require "capistrano/deploy_hooks/version"
+require "capistrano/deploy_hooks/tasks"

data/lib/capistrano/tasks/deploy_hooks.rake

@@ -0,0 +1,33 @@
+namespace :deploy_hooks do
+  namespace :deploy do
+    task :updating do
+      Capistrano::DeployHooks::Main.new(self).run(:updating)
+    end
+
+    task :reverting do
+      Capistrano::DeployHooks::Main.new(self).run(:reverting)
+    end
+
+    task :updated do
+      Capistrano::DeployHooks::Main.new(self).run(:updated)
+    end
+
+    task :reverted do
+      Capistrano::DeployHooks::Main.new(self).run(:reverted)
+    end
+
+    task :failed do
+      Capistrano::DeployHooks::Main.new(self).run(:failed)
+    end
+
+    task :test => %i[updating updated reverting reverted failed] do
+      # all tasks run as dependencies
+    end
+  end
+end
+
+before 'deploy:updating',           'deploy_hooks:deploy:updating'
+before 'deploy:reverting',          'deploy_hooks:deploy:reverting'
+after  'deploy:finishing',          'deploy_hooks:deploy:updated'
+after  'deploy:finishing_rollback', 'deploy_hooks:deploy:reverted'
+after  'deploy:failed',             'deploy_hooks:deploy:failed'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-deploy_hooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Campbell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- mike.campbell@meritec.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-deploy_hooks.gemspec
+- lib/capistrano-deploy_hooks.rb
+- lib/capistrano/deploy_hooks.rb
+- lib/capistrano/deploy_hooks/main.rb
+- lib/capistrano/deploy_hooks/messengers/mattermost.rb
+- lib/capistrano/deploy_hooks/tasks.rb
+- lib/capistrano/deploy_hooks/version.rb
+- lib/capistrano/tasks/deploy_hooks.rake
+homepage: https://www.github.com/meritec/capistrano-deploy_hooks
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Configurable deploy hooks for Capistrano
+test_files: []