capistrano-slackify 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f43d21b28dc2237a8c389c9925bde9e9f96947e
+  data.tar.gz: 8ca460ea89937d3b18074e6faea7a7d7280adda2
+SHA512:
+  metadata.gz: 95447efe53eb4ad20865629e3d800e93cea36c20242b849c4e62f54d2a994c7bdf5f22a61c23f211508dcdc6a49cf339d95f354bfa9ad6b99695322daa20fbeb
+  data.tar.gz: 46a2a7625fbee81dd9f677f97d4830d9eb96b528a72b11ca8fda0e11ccccaf9f55fc19f3539c1c46a89e0b93305364e36cb534b6fe8bbf2f1272039dc5dabf06

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3

data/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+## Contributing
+
+We love to get pull requests, here's how we like to work:
+
+- Open a pull request. Before you start coding, let's make sure we're on the same page.
+- Fork the repo.
+- Run the tests. We only take pull requests with passing tests: `bundle && rake`
+- Add a test for your change. Only refactoring and documentation changes require no new tests.
+- Make the test pass, following the conventions you see used in the source already.
+- If you have made a number of commits, squash them before pushing with.
+- Push to your fork and update your pull request.
+- We may suggest some changes or improvements or alternatives.
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 OnTheBeach Ltd
+
+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,52 @@
+# Capistrano Slackify
+
+Publish deploy notifications to [Slack](https://slack.com) - for [Capistrano v3](https://github.com/capistrano/capistrano).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-slackify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-slackify
+
+## Usage
+
+Require the gem in your `Capfile`:
+
+    require 'capistrano/slackfiy'
+
+And then set the required variables in `config/deploy.rb`:
+
+    set :slack_subdomain, 'my_slack_subdomain'
+    set :slack_token, 'my_slack_token'
+
+Ensure that you have enabled the [incoming webhooks integration](https://api.slack.com/).
+
+The task will run automatically on deploy, or can be run manually using:
+
+    `bundle exec cap production slack:notify`
+
+By default, this will publish something along the lines of:
+
+    Revision 64a3c1de of my_app deployed to production by seenmyfate
+
+###  Customisation
+
+Any of the defaults can be over-ridden in `config/deploy.rb`:
+
+    set :slack_channel, '#devops'
+    set :slack_username, 'Deploybot'
+    set :slack_text, -> { "Uh-oh, #{local_user} just deployed" }
+    set :slack_emoji, ':trollface:'
+
+### Copyright
+
+Copyright (c) 2014 OnTheBeach Ltd. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec

data/capistrano-slackify.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-slackify'
+  spec.version       = '1.0.0'
+  spec.authors       = ['seenmyfate']
+  spec.email         = ['seenmyfate@gmail.com']
+  spec.summary       = %q{Publish deployment notifications to Slack via the incoming webhooks integration}
+  spec.description   = %q{Publish deployment notifications to Slack via the incoming webhooks integration}
+  spec.homepage      = 'https://github.com/onthebeach/capistrano-slackify'
+  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_runtime_dependency 'capistrano', '>= 3.1.0'
+  spec.add_runtime_dependency 'yajl-ruby'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/capistrano/slackify.rb

@@ -0,0 +1,2 @@
+require 'slackify'
+load File.expand_path('../tasks/slackify.cap', __FILE__)

data/lib/capistrano/tasks/slackify.cap

@@ -0,0 +1,25 @@
+namespace :slack do
+  desc 'Notify Slack of a deployment via the incoming webhooks integration - ' \
+       ':slack_subdomain and :slack_token must be set'
+  task :notify do
+    run_locally do
+      info 'Notifying Slack of deploy'
+      execute :curl, '-X POST',
+        '--data-urlencode', fetch(:slack_payload),
+        fetch(:slack_url)
+    end
+  end
+
+  after 'deploy:finished', 'slack:notify'
+end
+
+namespace :load do
+  task :defaults do
+    set :slack_channel, '#general'
+    set :slack_username, 'Capistrano'
+    set :slack_text, -> { slack_text }
+    set :slack_emoji, ':ghost:'
+    set :slack_payload, -> { "'payload=#{slack_payload}'" }
+    set :slack_url, -> { slack_url }
+  end
+end

data/lib/slackify.rb

@@ -0,0 +1,54 @@
+require 'uri'
+require 'yajl/json_gem'
+module Slackify
+
+  class URL
+
+    def initialize(subdomain, token)
+      @subdomain, @token = subdomain, token
+    end
+
+    def to_s
+      uri.to_s
+    end
+
+    private
+
+    def uri
+      @uri ||= URI(
+        "https://#{@subdomain}.slack.com/services/hooks/incoming-webhook?token=#{@token}"
+      )
+    end
+  end
+
+  module Payload
+
+    def slack_payload
+      {
+        channel: fetch(:slack_channel),
+        username: fetch(:slack_username),
+        text: fetch(:slack_text),
+        icon_emoji: fetch(:slack_emoji)
+      }.to_json
+    end
+
+    def slack_text
+      "Revision #{fetch(:current_revision, fetch(:branch))} of " \
+        "#{fetch(:application)} deployed to #{fetch(:stage)} by #{local_user}"
+    end
+
+    def slack_url
+      URL.new(slack_subdomain, slack_token).to_s
+    end
+
+    def slack_subdomain
+      fetch(:slack_subdomain) { fail ':slack_subdomain is not set' }
+    end
+
+    def slack_token
+      fetch(:slack_token) { fail ':slack_token is not set' }
+    end
+
+  end
+end
+self.extend(Slackify::Payload)

data/spec/lib/slackify_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Slackify
+  describe URL do
+    let(:url) { URL.new(subdomain, token) }
+    let(:subdomain) { 'me' }
+    let(:token) { 'abc123' }
+
+    describe '.new' do
+      it 'takes a subdomain and a token' do
+        expect(url)
+      end
+    end
+
+    describe '#to_s' do
+      it 'returns the url as a string' do
+        expect(url.to_s).
+          to eq 'https://me.slack.com/services/hooks/incoming-webhook?token=abc123'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'slackify'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-slackify
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- seenmyfate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Publish deployment notifications to Slack via the incoming webhooks integration
+email:
+- seenmyfate@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-slackify.gemspec
+- lib/capistrano/slackify.rb
+- lib/capistrano/tasks/slackify.cap
+- lib/slackify.rb
+- spec/lib/slackify_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/onthebeach/capistrano-slackify
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Publish deployment notifications to Slack via the incoming webhooks integration
+test_files:
+- spec/lib/slackify_spec.rb
+- spec/spec_helper.rb
+has_rdoc: