capistrano-payload 0.1.0 → 0.3.0

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/Gemfile

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

data/README.md

@@ -20,25 +20,40 @@ Then configure URL:
 To test if it works type:
 
     cap payload:deploy
+    
+The best way to test out is to use http://www.postbin.org/.
+
+## Options
+
+- payload_url     — Primary URL where the data would be sent (required)
+- payload_format  — Payload format. Must be one of :json (default), :form, :yaml, :xml
+- payload_params  — Extra parameters to the request (api_key, etc.). *Note: extra parameters wont be added to the payload.*
+- payload_message — Ask for deployment comment. (default: true)
 
 ## Payload structure
 
-Plugin will sent JSON-encoded data via POST method.
+Plugin will sent a payload in one of the formats (FORM, JSON, YAML, XML) data via POST method.
 
-Here is the sample payload:
+Here is an example data:
 
     {
       "capistrano": {
+        "version": "2.6.0",
         "application": "APP_NAME",
-        "deployer": "sosedoff",
+        "deployer": {
+          "user": "sosedoff",
+          "hostname": "localhost",
+        }
         "timestamp": "2011-07-21 19:09:52 -0500",
+        "message": "Release 1.0.0", 
         "source": {
           "branch": "master",
           "revision": "b18ffa822c16c028765800d0c4d22bfd5e4f3bf9",
           "repository": "git@github.com:repository.git"
         },
         "action": "deploy"
-      }
+      },
+      "payload_version": "0.2.0"
     }
 
 That's it. Ready to roll.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require "bundler"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+end
+
+task :default => :spec
+task :test => :spec

data/capistrano-payload.gemspec

@@ -15,9 +15,12 @@ Gem::Specification.new do |gem|
   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_development_dependency 'rspec',      '~> 2.6'
+  gem.add_development_dependency 'xml-simple', '~> 1.1'
+  gem.add_development_dependency 'webmock',    '~> 1.6'
   
-  gem.add_runtime_dependency 'capistrano',  '~> 2.6'
-  gem.add_runtime_dependency 'rest-client', '~> 1.6'
-  gem.add_runtime_dependency 'multi_json',  '~> 1.0'
+  gem.add_runtime_dependency 'capistrano',     '~> 2.6'
+  gem.add_runtime_dependency 'rest-client',    '~> 1.6'
+  gem.add_runtime_dependency 'multi_json',     '~> 1.0'
+  gem.add_runtime_dependency 'builder',        '~> 3.0'
 end

data/lib/capistrano-payload/capistrano_integration.rb

@@ -1,4 +1,6 @@
 require 'capistrano'
+require 'capistrano/version'
+require 'socket'
 
 module CapistranoPayload
   class CapistranoIntegration
@@ -8,12 +10,18 @@ module CapistranoPayload
           abort 'Payload URL required! set :payload_url'
         }
         
-        _cset(:payload_format) { :json }
+        _cset(:payload_message) { true }
+        _cset(:payload_format)  { :json }
+        _cset(:payload_params)  { Hash.new }
         
         _cset(:payload_data) {
           {
+            :version         => Capistrano::Version.to_s.strip,
             :application     => fetch(:application),
-            :deployer        => ENV['USER'] || ENV['USERNAME'] || 'n/a',
+            :deployer        => {
+              :user          => ENV['USER'] || ENV['USERNAME'] || 'n/a',
+              :hostname      => ENV['HOSTNAME'] || Socket.gethostname
+            },
             :timestamp       => Time.now,
             :source          => {
               :branch        => fetch(:branch),
@@ -26,19 +34,25 @@ module CapistranoPayload
         namespace :payload do
           task :deploy, :roles => :app do
             logger.debug("Sending deployment notification to #{fetch(:payload_url)}")
+            message = payload_message == true ? Capistrano::CLI.ui.ask("Deployment message (none): ", nil) : ''
             begin
-              CapistranoPayload::Payload.new('deploy', payload_data).deliver(fetch(:payload_url))
+              CapistranoPayload::Payload.new('deploy', message, payload_data, payload_format, payload_params).deliver(payload_url)
             rescue DeliveryError => err
               logger.debug("Payload delivery error: #{err.message}")
+            rescue ConfigurationError => err
+              logger.debug("Payload configuration error: #{err.message}")
             end
           end
           
           task :rollback, :roles => :app do
             logger.debug("Sending rollback notification to #{fetch(:payload_url)}")
+            message = payload_message == true ? Capistrano::CLI.ui.ask("Rollback message (none): ", nil) : ''
             begin
-              CapistranoPayload::Payload.new('rollback', payload_data).deliver(fetch(:payload_url))
+              CapistranoPayload::Payload.new('rollback', message, payload_data, payload_format, payload_params).deliver(payload_url)
             rescue DeliveryError => err
               logger.debug("Payload delivery error: #{err.message}")
+            rescue ConfigurationError => err
+              logger.debug("Payload configuration error: #{err.message}")
             end
           end
         end

data/lib/capistrano-payload/format.rb

@@ -0,0 +1,66 @@
+require 'multi_json'
+require 'yaml'
+require 'builder'
+require 'time'
+
+module CapistranoPayload
+  module Format
+    # Allowed formats
+    FORMATS = [:form, :json, :yaml, :xml]
+    
+    # Method processing assignment
+    FORMAT_METHODS = {
+      :form => :to_hash,
+      :json => :to_json,
+      :yaml => :to_yaml,
+      :xml  => :to_xml
+    }
+    
+    # Returns a payload as HASH
+    #
+    def to_hash
+      {
+        :capistrano      => @data,
+        :payload_version => CapistranoPayload::VERSION
+      }
+    end
+    
+    # Returns a payload as JSON
+    #
+    def to_json
+      MultiJson.encode(self.to_hash)
+    end
+    
+    # Returns a payload as YAML
+    #
+    def to_yaml
+      YAML.dump(self.to_hash)
+    end
+    
+    # Returns a payload as XML
+    #
+    def to_xml    
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
+      xml.payload do |p|
+        p.capistrano do |c|
+          c.action        @data[:action]
+          c.message       @data[:message]
+          c.version       @data[:version]
+          c.application   @data[:application]
+          c.deployer do |d|
+            c.user        @data[:deployer][:user]
+            c.hostname    @data[:deployer][:hostname]
+          end
+          c.timestamp     @data[:timestamp].iso8601
+          c.source do |s|
+            c.branch      @data[:source][:branch]
+            c.revision    @data[:source][:revision]
+            c.repository  @data[:source][:repository]
+          end
+        end
+        p.payload_version CapistranoPayload::VERSION
+      end.to_s
+    end
+  end
+end

data/lib/capistrano-payload/payload.rb

@@ -1,30 +1,50 @@
-require 'rest-client'
-require 'multi_json'
-
 module CapistranoPayload
-  class DeliveryError < StandardError ; end
+  class ConfigurationError < StandardError ; end
+  class DeliveryError      < StandardError ; end
   
   class Payload
+    include CapistranoPayload::Format
+    include CapistranoPayload::Request
+    
+    # Allowed actions
+    ACTIONS = ['deploy', 'rollback']
+  
     attr_reader :action
+    attr_reader :message
     attr_reader :data
+    attr_reader :format
     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.
+    # action  - Deployment action (deploy, rollback)
+    # message - Deployment message (optional)
+    # data    - Payload data
+    # format  - Payload format (:json, :form). Default: json
+    # params  - Extra parameters to payload (api_key, etc.), default: {}
+    #           Could not contain 'capistrano' key. Will be removed if present.
+    #           Should be a hash
     # 
-    def initialize(action, data, params={})
-      @action = action
-      @data   = data.merge(:action => action)
-      @params = params
+    def initialize(action, message, data, format=:json, params={})
+      @action  = action
+      @message = message.strip
+      @data    = data.merge(:action => @action, :message => @message)
+      @format  = format.to_sym
+      @params  = params.kind_of?(Hash) ? params : {}
+      
+      unless ACTIONS.include?(@action)
+        raise ConfigurationError, "Invalid payload action: #{action}."
+      end
+      
+      # Check if we have an invalid format
+      unless FORMATS.include?(@format)
+        raise ConfigurationError, "Invalid payload format: #{format}."
+      end
       
-      # Check if we have 'capistrano' keys (string or symbolic)
+      # Check if we have 'payload' keys (string or symbolic)
       unless @params.empty?
-        @params.delete(:capistrano)
-        @params.delete('capistrano')
+        @params.delete(:payload)
+        @params.delete('payload')
       end
     end
     
@@ -33,9 +53,9 @@ module CapistranoPayload
     #   url - Target url
     #
     def deliver(url)
-      payload = MultiJson.encode({:capistrano => @data}.merge(@params))
+      payload = self.send(FORMAT_METHODS[@format])
       begin
-        RestClient.post(url, payload, :content_type => :json)
+        request(:post, url, {:payload => payload}.merge(@params), format)
       rescue Exception => ex
         raise DeliveryError, ex.message
       end

data/lib/capistrano-payload/request.rb

@@ -0,0 +1,35 @@
+require 'rest-client'
+
+module CapistranoPayload
+  module Request
+    TIMEOUT      = 4
+    OPEN_TIMEOUT = 4
+    
+    CONTENT_TYPES = {
+      :form => 'application/x-www-form-urlencoded',
+      :json => 'application/json',
+      :yaml => 'application/x-yaml',
+      :xml  => 'application/xml'
+    }.freeze
+    
+    # Performs a HTTP request
+    #
+    # method  - Request method (:get, :post, :put, :delete)
+    # url     - Target URL
+    # payload - Delivery content
+    # format  - Delivery format
+    #
+    def request(method, url, payload, format)
+      opts = {
+        :method       => method,
+        :url          => url,
+        :payload      => payload,
+        :headers      => {:content_type => CONTENT_TYPES[format]},
+        :timeout      => TIMEOUT,
+        :open_timeout => OPEN_TIMEOUT
+      }
+      
+      RestClient::Request.execute(opts)
+    end
+  end
+end

data/lib/capistrano-payload/version.rb

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

data/lib/capistrano-payload.rb

@@ -1,2 +1,5 @@
+require 'capistrano-payload/version'
+require 'capistrano-payload/request'
+require 'capistrano-payload/format'
 require 'capistrano-payload/payload'
 require 'capistrano-payload/capistrano_integration'

data/spec/fixtures/payload.form

@@ -0,0 +1 @@
+payload[capistrano][version]=2.6.0&payload[capistrano][application]=foobar&payload[capistrano][deployer][user]=username&payload[capistrano][deployer][hostname]=localhost&payload[capistrano][timestamp]=2011-01-01%2000%3A00%3A00%20-0600&payload[capistrano][source][branch]=master&payload[capistrano][source][revision]=abcdef&payload[capistrano][source][repository]=git%40github.com%3Ausername%2Frepo.git&payload[capistrano][action]=deploy&payload[capistrano][message]=Comment&payload[payload_version]=0.3.0

data/spec/fixtures/payload.json

@@ -0,0 +1,19 @@
+{
+    "capistrano": {
+        "version": "2.6.0",
+        "application": "foobar",
+        "deployer": {
+            "user": "username",
+            "hostname": "localhost"
+        },
+        "timestamp": "2011-01-01 00:00:00 -0600",
+        "source": {
+            "branch": "master",
+            "revision": "abcdef",
+            "repository": "git@github.com:username/repo.git"
+        },
+        "action": "deploy",
+        "message": "Comment"
+    },
+    "payload_version": "0.3.0"
+}

data/spec/fixtures/payload.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<payload>
+  <capistrano>
+    <action>deploy</action>
+    <message>Comment</message>
+    <version>2.6.0</version>
+    <application>foobar</application>
+    <deployer>
+      <user>username</user>
+      <hostname>localhost</hostname>
+    </deployer>
+    <timestamp>2011-01-01T00:00:00-06:00</timestamp>
+    <source>
+      <branch>master</branch>
+      <revision>abcdef</revision>
+      <repository>git@github.com:username/repo.git</repository>
+    </source>
+  </capistrano>
+  <payload_version>0.3.0</payload_version>
+</payload>

data/spec/fixtures/payload.yml

@@ -0,0 +1,15 @@
+--- 
+:capistrano: 
+  :version: 2.6.0
+  :application: foobar
+  :deployer: 
+    :user: username
+    :hostname: localhost
+  :timestamp: 2011-01-01 00:00:00 -06:00
+  :source: 
+    :branch: master
+    :revision: abcdef
+    :repository: git@github.com:username/repo.git
+  :action: deploy
+  :message: Comment
+:payload_version: 0.3.0

data/spec/format_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'CapistranoPayload::Format' do
+  include CapistranoPayload
+  
+  before :all do
+    @payload = Payload.new('deploy', 'Comment', PAYLOAD)
+  end
+
+  it 'renders HASH' do
+    data = @payload.to_hash
+    data.key?(:capistrano).should == true
+    data.key?(:payload_version).should == true
+    data[:payload_version].should == CapistranoPayload::VERSION
+  end
+
+  it 'renders JSON' do
+    @payload.to_json == json_fixture('payload.json')
+  end
+  
+  it 'renders YAML' do
+    @payload.to_yaml.should == fixture('payload.yml')
+    @payload.to_hash.should == yaml_fixture('payload.yml')
+  end
+  
+  it 'renders XML' do
+    f = xml_fixture_from_string(@payload.to_xml)
+    
+    
+    f.keys.should == xml_fixture('payload.xml').keys
+    f.keys.should == @payload.to_hash.keys
+    f[:capistrano].keys.should == xml_fixture('payload.xml')[:capistrano].keys
+  end
+end

data/spec/payload_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'CapistranoPayload::Payload' do
+  include CapistranoPayload
+  
+  it 'raises ConfigurationError on invalid action' do
+    proc { Payload.new('foo', '', {}) }.
+      should raise_error ConfigurationError, "Invalid payload action: foo."
+  end
+  
+  it 'raises ConfigurationError on invalid format' do
+    proc { Payload.new('deploy', '', {}, :foo) }.
+      should raise_error ConfigurationError, "Invalid payload format: foo."
+  end
+  
+  it 'assigns data fields' do
+    p = Payload.new('deploy', 'Comment', PAYLOAD)
+    p.action.should == 'deploy'
+    p.message.should == 'Comment'
+  end
+  
+  it 'discards an invalid extra parameters container' do
+    p = Payload.new('deploy', 'Comment', PAYLOAD, :json, 'Invalid params')
+    p.params.should be_a Hash
+    p.params.empty?.should == true
+  end
+  
+  it 'deletes an invalid extra parameters' do
+    p = Payload.new('deploy', 'Comment', PAYLOAD, :json, {'payload' => 'test', :payload => 'test', :api_key => 'test'})
+    p.params.size.should == 1
+    p.params.key?(:payload).should == false
+    p.params.key?('payload').should == false
+    p.params[:api_key].should == 'test'
+  end
+  
+  it 'responds to format renderers' do
+    p = Payload.new('deploy', 'Comment', PAYLOAD)
+    Format::FORMAT_METHODS.each_pair do |f, method|
+      p.respond_to?(method).should == true
+    end
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe 'CapistranoPayload::Request' do
+  include CapistranoPayload
+  
+  it 'raises DeliveryError on failed request' do
+    stub_request(:post, "http://localhost:4567/fail").
+      with(:body => fixture('payload.form'), :headers => {'Content-Type'=>'application/x-www-form-urlencoded'}).
+      to_return(:status => 404, :headers => {})
+    
+    p = Payload.new('deploy', 'Comment', PAYLOAD, :form)
+    proc { p.deliver('http://localhost:4567/fail') }.
+      should raise_error DeliveryError, "404 Resource Not Found"
+  end
+  
+  it 'delivers a payload' do
+    stub_request(:post, "http://foo.bar.com/payload").
+      with(:body => fixture('payload.form'), :headers => {'Content-Type'=>'application/x-www-form-urlencoded'}).
+      to_return(:status => 200, :headers => {})
+    
+    p = Payload.new('deploy', 'Comment', PAYLOAD, :form)
+    p.deliver('http://foo.bar.com/payload')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'spec_utils'
+require 'xmlsimple'
+require 'webmock'
+require 'webmock/rspec'
+require 'capistrano-payload'
+
+def fixture_path(file=nil)
+  path = File.expand_path("../fixtures", __FILE__)
+  path = File.join(path, file) unless file.nil?
+  path
+end
+
+def fixture(file)
+  File.read(File.join(fixture_path, file))
+end
+
+def json_fixture(file)
+  MultiJson.decode(fixture(file))
+end
+
+def yaml_fixture(file)
+  YAML.load(fixture(file))
+end
+
+def xml_fixture(file)
+  hash = XmlSimple.xml_in(fixture(file), 'ForceArray' => false, 'KeepRoot' => false)
+  hash.recursive_symbolize_keys!
+  hash
+end
+
+def xml_fixture_from_string(data)
+  hash = XmlSimple.xml_in(data, 'ForceArray' => false, 'KeepRoot' => false)
+  hash.recursive_symbolize_keys!
+  hash
+end
+
+PAYLOAD = {
+  :version         => "2.6.0",
+  :application     => "foobar",
+  :deployer        => {
+    :user          => "username",
+    :hostname      => "localhost"
+  },
+  :timestamp       => Time.mktime(2011, 1, 1, 0, 0, 0),
+  :source          => {
+    :branch        => 'master',
+    :revision      => 'abcdef',
+    :repository    => 'git@github.com:username/repo.git'
+  }
+}

data/spec/spec_utils.rb

@@ -0,0 +1,17 @@
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+  
+  def recursive_symbolize_keys!
+    symbolize_keys!
+    # symbolize each hash in .values
+    values.each{|h| h.recursive_symbolize_keys! if h.is_a?(Hash) }
+    # symbolize each hash inside an array in .values
+    values.select{|v| v.is_a?(Array) }.flatten.each{|h| h.recursive_symbolize_keys! if h.is_a?(Hash) }
+    self
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: capistrano-payload
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Dan Sosedoff
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-21 00:00:00 -05:00
+date: 2011-07-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,38 +25,71 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: capistrano
+  name: xml-simple
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: "2.6"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: "1.6"
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: multi_json
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: "1.0"
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id007
 description: Capistrano plugin that delivers JSON payload to the specified URL
 email: dan.sosedoff@gmail.com
 executables: []
@@ -67,12 +100,26 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
+- Gemfile
 - README.md
+- Rakefile
 - capistrano-payload.gemspec
 - lib/capistrano-payload.rb
 - lib/capistrano-payload/capistrano_integration.rb
+- lib/capistrano-payload/format.rb
 - lib/capistrano-payload/payload.rb
+- lib/capistrano-payload/request.rb
 - lib/capistrano-payload/version.rb
+- spec/fixtures/payload.form
+- spec/fixtures/payload.json
+- spec/fixtures/payload.xml
+- spec/fixtures/payload.yml
+- spec/format_spec.rb
+- spec/payload_spec.rb
+- spec/request_spec.rb
+- spec/spec_helper.rb
+- spec/spec_utils.rb
 has_rdoc: true
 homepage: https://github.com/sosedoff/capistrano-payload
 licenses: []
@@ -101,5 +148,13 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: JSON webhook on capistrano deployments
-test_files: []
-
+test_files: 
+- spec/fixtures/payload.form
+- spec/fixtures/payload.json
+- spec/fixtures/payload.xml
+- spec/fixtures/payload.yml
+- spec/format_spec.rb
+- spec/payload_spec.rb
+- spec/request_spec.rb
+- spec/spec_helper.rb
+- spec/spec_utils.rb