capistrano-bearychat 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77a6e6e3cf614e6a9df90a545b9e26fae46c383d
+  data.tar.gz: d39df11929be25aa6f6914184b07b1fe3544d84c
+SHA512:
+  metadata.gz: e065a92518089ea396dbce01331f3e892921c8b6185ff3a76556f5e79ea5987a082f48bb05dceb82881f111445d59faca5980419dda2dd064984b95d44092811
+  data.tar.gz: 75a48a34f6b953cfc775cc4ea2550ab12bc02525adea7006a1aae53a5bbe0fcaf28ce9c6d3b5c0ec1d645ab9f311d119d3e15361654cd40846b1c46c10e1cb20

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kai Chen
+
+MIT License
+
+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,70 @@
+# Capistrano::Bearychat
+
+Send notifications to [Bearychat](https://bearychat.com) about [Capistrano v3](http://www.capistranorb.com) deployments. Inspired by [slackistrano](https://github.com/supremegolf/slackistrano).
+
+## Requirements
+
+- Capistrano >= 3.1.0
+- Ruby >= 2.0
+- A Bearychat account
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "capistrano",  "~> 3.1"
+    gem "capistrano-bearychat", require: false
+
+And then execute:
+
+    $ bundle
+
+## Configuration
+
+To notify a channel in Bearychat when you deploy, Using *Incoming WebHooks* integration, offering more options but requires one of the five free integrations.
+
+You need to enable the integration inside Bearychat and get the incoming webhook url that will be needed later.
+
+Require the library in your application's Capfile:
+
+    require 'capistrano/bearychat'
+
+You need to set your webhook url in your application's config/deploy.rb:
+
+    set :bearychat_webhook, "https://hook.bearychat.com/XXXX/XXX/XXXXX"
+
+Optionally, override the other settings:
+
+    set :bearychat_channel,          -> { '#general' }
+    set :bearychat_using_markdown,   ->{ false } # Set to true to treat text as markdown.
+    set :bearychat_channel_starting, -> { nil } # Channel to post to. Optional. Defaults to :bearychat_channel.
+    set :bearychat_channel_finished, -> { nil } # Channel to post to. Optional. Defaults to :bearychat_channel.
+    set :bearychat_channel_failed,   -> { nil } # Channel to post to. Optional. Defaults to :bearychat_channel.
+    set :bearychat_run_starting,     -> { true }
+    set :bearychat_run_finished,     -> { true }
+    set :bearychat_run_failed,       -> { true }
+    set :bearychat_msg_starting,     -> { "#{ENV['USER'] || ENV['USERNAME']} has started deploying branch #{fetch :branch} of #{fetch :application} to #{fetch :rails_env, 'production'}" }
+    set :bearychat_msg_finished,     -> { "#{ENV['USER'] || ENV['USERNAME']} has finished deploying branch #{fetch :branch} of #{fetch :application} to #{fetch :rails_env, 'production'}" }
+    set :bearychat_msg_failed,       -> { "#{ENV['USER'] || ENV['USERNAME']} failed to deploy branch #{fetch :branch} of #{fetch :application} to #{fetch :rails_env, 'production'}" }
+
+**Note**: You may wish to disable one of the notifications if another service (ex:
+Honeybadger) also displays a deploy notification.
+
+Test your setup by running:
+
+    $ cap production bearychat:deploy:starting
+    $ cap production bearychat:deploy:finished
+    $ cap production bearychat:deploy:failed
+
+## Usage
+
+Deploy your application like normal and you should see messages in the channel
+you specified.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task default: :build

data/capistrano-bearychat.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-bearychat"
+  gem.version       = "1.0"
+  gem.authors       = ["Kai Chen"]
+  gem.email         = ["kai@thekaiway.com"]
+  gem.description   = %q{Send notifications to Bearychat about Capistrano deployments.}
+  gem.summary       = %q{Send notifications to Bearychat about Capistrano deployments.}
+  gem.homepage      = "https://github.com/kaichen/capistrano-bearychat"
+  gem.license       = 'MIT'
+
+  gem.required_ruby_version = '>= 2.0.0'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '>= 3.0.1'
+  gem.add_dependency 'json'
+  gem.add_development_dependency 'rake'
+end

data/lib/capistrano/bearychat.rb

@@ -0,0 +1,20 @@
+require "net/http"
+require "json"
+
+load File.expand_path("../tasks/bearychat.rake", __FILE__)
+
+module Capistrano
+  module Bearychat
+    extend self
+
+    def post(webhook, payload: {})
+      if webhook.nil?
+        raise ArgumentError, "Please set bearychat_webhook in your deploy.rb file"
+      end
+      Net::HTTP.post_form(URI(webhook), "payload" => payload.to_json)
+    rescue => e
+      puts "There was an error notifying Bearychat."
+      puts e.inspect
+    end
+  end
+end

data/lib/capistrano/tasks/bearychat.rake

@@ -0,0 +1,71 @@
+namespace :bearychat do
+  namespace :deploy do
+    task :starting do
+      if fetch(:bearychat_run_starting)
+        run_locally do
+          Capistrano::Bearychat.post(
+            fetch(:bearychat_webhook),
+            payload: {
+              channel: fetch(:bearychat_channel_starting) || fetch(:bearychat_channel),
+              text: fetch(:bearychat_msg_starting),
+              using_markdown: fetch(:bearychat_using_markdown)
+            }
+          )
+        end
+      end
+    end
+
+    task :finished do
+      if fetch(:bearychat_run_finished)
+        run_locally do
+          Capistrano::Bearychat.post(
+            fetch(:bearychat_webhook),
+            payload: {
+              channel: fetch(:bearychat_channel_finished) || fetch(:bearychat_channel),
+              text: fetch(:bearychat_msg_finished),
+              using_markdown: fetch(:bearychat_using_markdown)
+            }
+          )
+        end
+      end
+    end
+
+    task :failed do
+      if fetch(:bearychat_run_failed)
+        run_locally do
+          Capistrano::Bearychat.post(
+            fetch(:bearychat_webhook),
+            payload: {
+              channel: fetch(:bearychat_channel_failed) || fetch(:bearychat_channel),
+              text: fetch(:bearychat_msg_failed),
+              using_markdown: fetch(:bearychat_using_markdown)
+            }
+          )
+        end
+      end
+    end
+
+  end
+end
+
+after 'deploy:starting', 'bearychat:deploy:starting'
+after 'deploy:finished', 'bearychat:deploy:finished'
+after 'deploy:failed',   'bearychat:deploy:failed'
+
+namespace :load do
+  task :defaults do
+    set :bearychat_webhook,          ->{ nil } # Incoming WebHook URL.
+    set :bearychat_using_markdown,   ->{ false } # Set to true to treat text as markdown.
+
+    set :bearychat_channel,          -> { nil } # Channel to post to. Optional. Defaults to WebHook setting.
+    set :bearychat_channel_starting, -> { nil } # Channel to post to. Optional. Defaults to :bearychat_channel.
+    set :bearychat_channel_finished, -> { nil } # Channel to post to. Optional. Defaults to :bearychat_channel.
+    set :bearychat_channel_failed,   -> { nil } # Channel to post to. Optional. Defaults to :bearychat_channel.
+    set :bearychat_run_starting,     -> { true } # Set to false to disable starting message.
+    set :bearychat_run_finished,     -> { true } # Set to false to disable finished message.
+    set :bearychat_run_failed,       -> { true } # Set to false to disable failure message.
+    set :bearychat_msg_starting,     -> { "#{ENV['USER'] || ENV['USERNAME']} has started deploying branch #{fetch :branch} of #{fetch :application} to #{fetch :stage, 'an unknown stage'}" }
+    set :bearychat_msg_finished,     -> { "#{ENV['USER'] || ENV['USERNAME']} has finished deploying branch #{fetch :branch} of #{fetch :application} to #{fetch :stage, 'an unknown stage'}" }
+    set :bearychat_msg_failed,       -> { "#{ENV['USER'] || ENV['USERNAME']} failed to deploy branch #{fetch :branch} of #{fetch :application} to #{fetch :stage, 'an unknown stage'}" }
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-bearychat
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Kai Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Send notifications to Bearychat about Capistrano deployments.
+email:
+- kai@thekaiway.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-bearychat.gemspec
+- lib/capistrano-bearychat.rb
+- lib/capistrano/bearychat.rb
+- lib/capistrano/tasks/bearychat.rake
+homepage: https://github.com/kaichen/capistrano-bearychat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Send notifications to Bearychat about Capistrano deployments.
+test_files: []