capistrano-payload 0.1.0

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/README.md

@@ -0,0 +1,54 @@
+
+# Capistrano Payload
+
+Capistrano plugin that delivers JSON-encoded deployment information via POST to the URL of your choice.
+
+## Installation
+
+    gem install capistrano-payload
+    
+## Usage
+
+Add payload plugin into your deploy.rb file:
+
+    require 'capistrano-payload'
+    
+Then configure URL:
+
+    set :payload_url, "http://your.awesome.url.com/payload"
+
+To test if it works type:
+
+    cap payload:deploy
+
+## Payload structure
+
+Plugin will sent JSON-encoded data via POST method.
+
+Here is the sample payload:
+
+    {
+      "capistrano": {
+        "application": "APP_NAME",
+        "deployer": "sosedoff",
+        "timestamp": "2011-07-21 19:09:52 -0500",
+        "source": {
+          "branch": "master",
+          "revision": "b18ffa822c16c028765800d0c4d22bfd5e4f3bf9",
+          "repository": "git@github.com:repository.git"
+        },
+        "action": "deploy"
+      }
+    }
+
+That's it. Ready to roll.
+
+## License
+
+Copyright © 2011 Dan Sosedoff.
+
+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/capistrano-payload.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/capistrano-payload/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'capistrano-payload'
+  gem.version     = CapistranoPayload::VERSION.dup
+  gem.author      = 'Dan Sosedoff'
+  gem.email       = 'dan.sosedoff@gmail.com'
+  gem.homepage    = 'https://github.com/sosedoff/capistrano-payload'
+  gem.summary     = %q{JSON webhook on capistrano deployments}
+  gem.description = %q{Capistrano plugin that delivers JSON payload to the specified URL}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  
+  gem.add_runtime_dependency 'capistrano',  '~> 2.6'
+  gem.add_runtime_dependency 'rest-client', '~> 1.6'
+  gem.add_runtime_dependency 'multi_json',  '~> 1.0'
+end

data/lib/capistrano-payload.rb

@@ -0,0 +1,2 @@
+require 'capistrano-payload/payload'
+require 'capistrano-payload/capistrano_integration'

data/lib/capistrano-payload/capistrano_integration.rb

@@ -0,0 +1,55 @@
+require 'capistrano'
+
+module CapistranoPayload
+  class CapistranoIntegration
+    def self.load_into(capistrano_config)
+      capistrano_config.load do  
+        _cset(:payload_url) {
+          abort 'Payload URL required! set :payload_url'
+        }
+        
+        _cset(:payload_format) { :json }
+        
+        _cset(:payload_data) {
+          {
+            :application     => fetch(:application),
+            :deployer        => ENV['USER'] || ENV['USERNAME'] || 'n/a',
+            :timestamp       => Time.now,
+            :source          => {
+              :branch        => fetch(:branch),
+              :revision      => fetch(:real_revision),
+              :repository    => fetch(:repository)
+            }
+          }
+        }
+      
+        namespace :payload do
+          task :deploy, :roles => :app do
+            logger.debug("Sending deployment notification to #{fetch(:payload_url)}")
+            begin
+              CapistranoPayload::Payload.new('deploy', payload_data).deliver(fetch(:payload_url))
+            rescue DeliveryError => err
+              logger.debug("Payload delivery error: #{err.message}")
+            end
+          end
+          
+          task :rollback, :roles => :app do
+            logger.debug("Sending rollback notification to #{fetch(:payload_url)}")
+            begin
+              CapistranoPayload::Payload.new('rollback', payload_data).deliver(fetch(:payload_url))
+            rescue DeliveryError => err
+              logger.debug("Payload delivery error: #{err.message}")
+            end
+          end
+        end
+        
+        after :deploy,   'payload:deploy'
+        after :rollback, 'payload:rollback'
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  CapistranoPayload::CapistranoIntegration.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano-payload/payload.rb

@@ -0,0 +1,44 @@
+require 'rest-client'
+require 'multi_json'
+
+module CapistranoPayload
+  class DeliveryError < StandardError ; end
+  
+  class Payload
+    attr_reader :action
+    attr_reader :data
+    attr_reader :params
+    
+    # Initialize a new Payload object
+    #
+    #   action - Deployment action (deploy, rollback)
+    #   data   - Deployment parameters
+    #   params - Extra parameters to payload (api_key, etc.), default: {}
+    #            Could not contain 'capistrano' key. Will be removed if present.
+    # 
+    def initialize(action, data, params={})
+      @action = action
+      @data   = data.merge(:action => action)
+      @params = params
+      
+      # Check if we have 'capistrano' keys (string or symbolic)
+      unless @params.empty?
+        @params.delete(:capistrano)
+        @params.delete('capistrano')
+      end
+    end
+    
+    # Performs payload delivery
+    #
+    #   url - Target url
+    #
+    def deliver(url)
+      payload = MultiJson.encode({:capistrano => @data}.merge(@params))
+      begin
+        RestClient.post(url, payload, :content_type => :json)
+      rescue Exception => ex
+        raise DeliveryError, ex.message
+      end
+    end
+  end
+end

data/lib/capistrano-payload/version.rb

@@ -0,0 +1,3 @@
+module CapistranoPayload
+  VERSION = "0.1.0".freeze unless defined? ::CapistranoPayload::VERSION
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-payload
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-21 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.6"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id004
+description: Capistrano plugin that delivers JSON payload to the specified URL
+email: dan.sosedoff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.md
+- capistrano-payload.gemspec
+- lib/capistrano-payload.rb
+- lib/capistrano-payload/capistrano_integration.rb
+- lib/capistrano-payload/payload.rb
+- lib/capistrano-payload/version.rb
+has_rdoc: true
+homepage: https://github.com/sosedoff/capistrano-payload
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: JSON webhook on capistrano deployments
+test_files: []
+