capistrano-notifications 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7206bacffdeab09b3d57eeb83820a09923c2aa90
+  data.tar.gz: 46e25ffe6c17e06b479dc6756ce552460725a723
+SHA512:
+  metadata.gz: c135f5e6cde1151e1b4096aa77540d126afeb11351a57252a5482af6912c2ebfe1ab03c5f78899d38f81dfeb5ca6de4dcd35e6795324a5b7fc6a42cab991c360
+  data.tar.gz: c53393e19861dd3390d3d0c4c14cc0712c2597a8fb017dfb6d0639a213cb9574d184ce59cb41a72a95de07c9a6bef36ec0d90734792ba0cd055ab8d35dcb0115

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.ruby-version
+.ruby-gemset
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 scorix
+
+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,45 @@
+# Capistrano::Notifications
+
+Send notifications around deploy to teammates(subscribers).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-notifications', github: 'scorix/capistrano-notifications'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Slack
+
+in deploy.rb
+
+```ruby
+# deploy.rb
+set :notify_default_options, team: 'my-team', token: 'token'
+set :notify_adapter, :Slack
+set :subscribers, %w(@scorix #deploy)
+```
+
+in Capfile
+
+```ruby
+# Capfile
+
+require 'capistrano/notifications'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/scorix/capistrano-notifications/fork )
+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 a new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/capistrano-notifications.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-notifications'
+  spec.version       = Capistrano::Notifications::VERSION
+  spec.authors       = ['scorix']
+  spec.email         = ['scorix@gmail.com']
+  spec.summary       = %q{Capistrano notifications.}
+  spec.description   = %q{Send deploy notifications to subscribers.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'capistrano', '~> 3.3.5'
+
+  spec.add_dependency 'faraday'
+end

data/lib/capistrano/notifications/adapter/base.rb

@@ -0,0 +1,27 @@
+module Capistrano
+  module Notifications
+    module Adapter
+      class Base
+
+        def self.setup(*args)
+          options = args.last.is_a?(Hash) ? args.last : {}
+
+          instance = self.new
+          options.each { |k, v| instance.instance_variable_set("@#{k}", v) }
+          instance
+        end
+
+        def notify(members = [], message = '')
+          members.each { |member| send_notification(member, message) }
+        end
+
+        protected
+
+        def send_notification(_member, _message)
+          raise NoMethodError, 'send_notification is not defined.'
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/notifications/adapter/slack.rb

@@ -0,0 +1,33 @@
+module Capistrano
+  module Notifications
+    module Adapter
+      class Slack < Base
+
+        attr_reader :team, :token
+
+        protected
+        def send_notification(_member, _message)
+          connection = Faraday.new(url: "https://#{team}.slack.com") do |faraday|
+            faraday.request :url_encoded
+            faraday.adapter Faraday.default_adapter
+          end
+          connection.post do |req|
+            req.url '/services/hooks/incoming-webhook'
+            req.headers['User-Agent'] = "Capistrano Notification #{Capistrano::Notifications::VERSION}"
+            req.body = {
+                token: token,
+                payload: {
+                    channel: "#{_member}",
+                    username: "#{fetch(:application)} #{fetch(:env)}",
+                    text: _message,
+                    icon_emoji: ':grin:',
+                    mrkdwn: true
+                }.to_json
+            }
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/notifications/adapter.rb

@@ -0,0 +1,8 @@
+module Capistrano
+  module Notifications
+    module Adapter
+      autoload :Base, 'capistrano/notifications/adapter/base'
+      autoload :Slack, 'capistrano/notifications/adapter/slack'
+    end
+  end
+end

data/lib/capistrano/notifications/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Notifications
+    VERSION = '0.0.1'
+  end
+end

data/lib/capistrano/notifications.rb

@@ -0,0 +1,10 @@
+require 'faraday'
+require 'json'
+
+module Capistrano
+  module Notifications
+    autoload :Adapter, 'capistrano/notifications/adapter'
+  end
+end
+
+load File.expand_path('../tasks/notifications.rake', __FILE__)

data/lib/capistrano/tasks/notifications.rake

@@ -0,0 +1,92 @@
+#
+# adapters:
+#
+#   * Slack
+#
+#     example:
+#
+#       set :notify_adapter, :Slack
+#
+set :notify_adapter, -> { nil }
+
+#
+# default options:
+#
+#   * Slack:
+#
+#       team **required**
+#
+#       token **required**
+#
+#      example:
+#
+#        set :notify_default_options, team: 'my-team', token: 'token'
+#
+set :notify_default_options, -> { {} }
+
+#
+# subscribers
+#
+#    * Slack:
+#
+#      subscribers could be a user, or a channel
+#
+#      example:
+#
+#        set :subscribers, -> { ['@scorix', '#deploy'] }
+#
+set :subscribers, -> { [] }
+
+namespace :notify do
+
+  def find_adapter
+    adapter = fetch(:notify_adapter, nil)
+
+    if adapter
+      adapter = Capistrano::Notifications::Adapter.const_get(adapter.to_sym).setup(fetch(:notify_default_options))
+
+      begin
+        yield adapter
+      rescue => e
+        warn e.message
+      end
+    end
+  end
+
+  task :starting do
+    find_adapter do |adapter|
+      adapter.notify(fetch(:subscribers), "@#{local_user} is deploying branch #{fetch(:branch)}")
+    end
+  end
+
+  task :finishing do
+    find_adapter do |adapter|
+      adapter.notify(fetch(:subscribers), t(:revision_log_message,
+                                            branch: fetch(:branch),
+                                            user: "@#{local_user}",
+                                            sha: fetch(:current_revision),
+                                            release: fetch(:release_timestamp)))
+    end
+  end
+
+  task :log_revision do
+    on primary(:app) do
+      previous_revision = nil
+
+      within releases_path do
+        previous_revision = capture(:grep, "deployed #{revision_log} | tail -n 1 | cut -f1 -d')' | cut -f4 -d' '")
+      end
+
+      within repo_path do
+        git_log = capture(:git, "log --oneline --no-color #{fetch(:branch)} #{previous_revision}..#{fetch(:current_revision)} | sed 's/^M$//'")
+        set(:git_log, git_log)
+      end
+    end
+  end
+
+end
+
+before 'deploy:log_revision', 'notify:log_revision'
+before 'deploy:starting', 'notify:starting'
+
+after 'deploy:finishing', 'notify:finishing'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-notifications
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- scorix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+description: Send deploy notifications to subscribers.
+email:
+- scorix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-notifications.gemspec
+- lib/capistrano/notifications.rb
+- lib/capistrano/notifications/adapter.rb
+- lib/capistrano/notifications/adapter/base.rb
+- lib/capistrano/notifications/adapter/slack.rb
+- lib/capistrano/notifications/version.rb
+- lib/capistrano/tasks/notifications.rake
+homepage: ''
+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: Capistrano notifications.
+test_files: []