capistrano-hook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bcc558b728d64f19584877152cf868fa05c34e0
+  data.tar.gz: 9d6d9928e189d4d10d5d7c040c7b476e910e8ccd
+SHA512:
+  metadata.gz: a0b08c655b908e49deff5fa05ceb0f49bc9a36a3b4810c8d4fd9de8829705ce99fc0b839dcf66356421f367a5a55ab8b191888a9a722e3f689a0684e4896c91e
+  data.tar.gz: dc2432d843a704f4138f2a3b4b8a3552121e189019af6b68fa645187306880d998d72667b892ef0720150faa656a4580993e8e9033dd75fc9f92e7338e554d4c

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,43 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-07-29 21:24:29 +0900 using RuboCop version 0.32.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.
+
+# Offense count: 2
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 104
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 3
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Offense count: 20
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2.2
+  - 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:
+  - bundle exec rake
+  - bundle exec rubocop

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Capfile

@@ -0,0 +1,5 @@
+require 'capistrano/setup'
+require 'capistrano/deploy'
+require 'capistrano/hook'
+
+# Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 yulii
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Capistrano::Hook
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-hook'
+```
+
+## Usage
+
+Add this line to your Capfile:
+
+```ruby
+require 'capistrano/hook'
+```
+
+Capistrano hook will not be run with no settings. You can setting the variables shown below.
+
+```ruby
+set :webhook_url, 'http://hooks.yulii.net/services'
+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.' }
+```
+
+### Slack
+
+Create incoming webhooks into Slack.
+
+```ruby
+set :webhook_url, 'http://hooks.yulii.net/services'
+set :webhook_starting_payload, {
+  username:   'Capistrano',
+  icon_emoji: ':monkey_face:',
+  text:       'Now, deploying...'
+}
+set :webhook_finished_payload, {
+  username:   'Capistrano',
+  icon_emoji: ':monkey_face:',
+  text:       'Deployment has been completed!'
+}
+set :webhook_failed_payload, {
+  username:   'Capistrano',
+  icon_emoji: ':monkey_face:',
+  text:       'Oops! something went wrong.'
+}
+```
+
+[Slack API - Incoming Webhooks](https://api.slack.com/incoming-webhooks)
+
+## 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/yulii/capistrano-hook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/hook'
+
+# 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/rubocop-auto-correct

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -euo pipefail
+CWD=$(pwd)
+SWD=$(cd `dirname $0` && pwd)
+IFS=$'\n\t'
+
+test -f $SWD/../.rubocop_todo.yml && rm $SWD/../.rubocop_todo.yml
+bundle exec rubocop --auto-correct --auto-gen-config

data/bin/setup

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

data/capistrano-hook.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/hook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-hook'
+  spec.version       = Capistrano::Hook::VERSION
+  spec.authors       = ['yulii']
+  spec.email         = ['yuliinfo@gmail.com']
+
+  spec.summary       = 'Simple Hook for Capistrano'
+  spec.description   = 'Simple Hook for Capistrano'
+  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)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '~> 3.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rubocop'
+end

data/config/deploy.rb

@@ -0,0 +1,44 @@
+# config valid only for current version of Capistrano
+lock '3.4.0'
+
+set :application, 'capistrano-hook'
+set :repo_url, 'git@github.com:yulii/capistrano-hook.git'
+
+# Default branch is :master
+# ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp
+
+set :deploy_to, '/tmp'
+set :scm, :git
+
+# Default value for :format is :pretty
+# set :format, :pretty
+
+# Default value for :log_level is :debug
+# set :log_level, :debug
+
+# Default value for :pty is false
+# set :pty, true
+
+# Default value for :linked_files is []
+# set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml')
+
+# Default value for linked_dirs is []
+# set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system')
+
+# Default value for default_env is {}
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+set :keep_releases, 5
+
+namespace :deploy do
+
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      # Here we can do anything such as:
+      # within release_path do
+      #   execute :rake, 'cache:clear'
+      # end
+    end
+  end
+
+end

data/config/deploy/production.rb

@@ -0,0 +1,44 @@
+# 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, 'http://yulii.net/webhook'
+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.' }
+
+# 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/staging.rb

@@ -0,0 +1,61 @@
+# 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
+# =============
+# 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.
+
+
+
+# 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',
+#   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/lib/capistrano/hook.rb

@@ -0,0 +1,4 @@
+require 'capistrano/hook/version'
+require 'capistrano/hook/web'
+
+load File.expand_path('../tasks/webhook.rake', __FILE__)

data/lib/capistrano/hook/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Hook
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/capistrano/hook/web.rb

@@ -0,0 +1,31 @@
+require 'json'
+module Capistrano
+  module Hook
+    class Web
+      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)
+      end
+
+      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)
+        end
+      end
+
+      def self.client(url)
+        new(url)
+      end
+
+      protected
+
+      attr_reader :uri, :http
+    end
+  end
+end

data/lib/capistrano/tasks/webhook.rake

@@ -0,0 +1,79 @@
+namespace :webhook do
+
+  desc <<-DESC
+    Capistrano hook will not be run with no settings.
+
+    You can setting the variables shown below.
+
+      set :webhook_url, 'http://yulii.net/'
+      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.' }
+
+  DESC
+
+  def response_message(result, params)
+    "POST webhook HTTP #{result.code} #{result.message} body='#{result.body}' payload=#{params}"
+  end
+
+  namespace :post do
+
+    task :starting do
+      run_locally do
+        url     = fetch(:webhook_url)
+        payload = fetch(:webhook_starting_payload)
+        next if payload.nil? || payload.empty?
+        begin
+          result = Capistrano::Hook::Web.client(url).post(payload)
+          if result.is_a?(Net::HTTPSuccess)
+            info response_message(result, payload)
+          else
+            error response_message(result, payload)
+          end
+        rescue StandardError => e
+          error "[webhook:post:starting] #{e.class} #{e.message}"
+        end
+      end
+    end
+
+    task :finished do
+      run_locally do
+        url     = fetch(:webhook_url)
+        payload = fetch(:webhook_finished_payload)
+        next if payload.nil? || payload.empty?
+        begin
+          result = Capistrano::Hook::Web.client(url).post(payload)
+          if result.is_a?(Net::HTTPSuccess)
+            info response_message(result, payload)
+          else
+            error response_message(result, payload)
+          end
+        rescue StandardError => e
+          error "[webhook:post:finishing] #{e.class} #{e.message}"
+        end
+      end
+    end
+
+    task :failed do
+      run_locally do
+        url     = fetch(:webhook_url)
+        payload = fetch(:webhook_failed_payload)
+        next if payload.nil? || payload.empty?
+        begin
+          result = Capistrano::Hook::Web.client(url).post(payload)
+          if result.is_a?(Net::HTTPSuccess)
+            info response_message(result, payload)
+          else
+            error response_message(result, payload)
+          end
+        rescue StandardError => e
+          error "[webhook:post:failed] #{e.class} #{e.message}"
+        end
+      end
+    end
+
+    before 'deploy:starting',  'webhook:post:starting'
+    after  'deploy:finishing', 'webhook:post:finished'
+    after  'deploy:failed',    'webhook:post:failed'
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-hook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yulii
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Simple Hook for Capistrano
+email:
+- yuliinfo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Capfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop-auto-correct
+- bin/setup
+- capistrano-hook.gemspec
+- config/deploy.rb
+- config/deploy/production.rb
+- config/deploy/staging.rb
+- lib/capistrano/hook.rb
+- lib/capistrano/hook/version.rb
+- lib/capistrano/hook/web.rb
+- lib/capistrano/tasks/webhook.rake
+homepage: https://github.com/yulii/capistrano-hook
+licenses:
+- MIT
+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.5
+signing_key: 
+specification_version: 4
+summary: Simple Hook for Capistrano
+test_files: []