capistrano-pusher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 591a30589281f4a1d15a2113a3ede58a135c1c22
+  data.tar.gz: e0535a241616b2ff89ad1b4143292cd7215e1cb7
+SHA512:
+  metadata.gz: 81c40bd4f517c6e2381507720a34d2328957d3bda5d9aeef8f5b1e6ff00a05ca7eb9c23db76bfe2aaa60b0a485d978cc11645c778d9ec171b543ab57e241d444
+  data.tar.gz: fe2fb65fa768264f5957757eceb55be3a0f897d6001de1d61cbfb41ff564e64353bee17e2fb4a944060f2e240914b627b1a4edf1f30d355d817e8200e515269e

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 seenmyfate
+
+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,82 @@
+# Capistrano Pusher [![Build Status](https://travis-ci.org/onthebeach/capistrano-pusher.svg)](https://travis-ci.org/onthebeach/capistrano-pusher) [![Code Climate](https://codeclimate.com/github/onthebeach/capistrano-pusher/badges/gpa.svg)](https://codeclimate.com/github/onthebeach/capistrano-pusher) [![Gem Version](https://badge.fury.io/rb/capistrano-pusher.svg)](http://badge.fury.io/rb/capistrano-pusher)
+
+Publish deploy notifications to [Pusher](https://pusher.com) - for [Capistrano v3](https://github.com/capistrano/capistrano).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-pusher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-pusher
+
+## Usage
+
+Require the gem in your `Capfile`:
+
+    require 'capistrano/pusher'
+
+And then set the required variables in `config/deploy.rb`:
+
+    set :pusher_url,  'http://abc:123@api.pusherapp.com/apps/0'
+
+The task will run automatically on deploy. Alternatively, you can notify of a deploy started manually by using:
+
+    bundle exec cap production pusher:notify_started
+
+Or to notify of a finished deploy:
+
+    bundle exec cap production pusher:notify_finished
+
+By default, this will publish something along the lines of:
+
+    Revision 64a3c1de of my_app deployed to production by seenmyfate in 333 seconds.
+
+If a deploy has failed, the following message will be published by default:
+
+    production deploy of my_app with revision/branch 64a3c1de failed
+
+As with the other tasks, it is also possible to notify failures manually:
+
+    bundle exec cap production pusher:notify_failed
+
+###  Customisation
+
+Any of the defaults can be over-ridden in `config/deploy.rb`:
+
+    set :pusher_channel, 'capistrano'
+    set :pusher_user, ENV['GIT_AUTHOR_NAME']
+    set :pusher_payload, -> {
+      {
+        message: fetch(:pusher_message),
+        user: fetch(:pusher_user),
+        application: fetch(:application),
+        revision: fetch(:current_revision),
+        branch: fetch(:branch),
+        stage: fetch(:stage),
+        state: fetch(:pusher_state)
+      }
+    }
+    set :pusher_deploy_completed_text, -> {
+      elapsed = Integer(fetch(:time_finished) - fetch(:time_started))
+      "Revision #{fetch(:current_revision, fetch(:branch))} of " \
+      "#{fetch(:application)} deployed to #{fetch(:stage)} by #{fetch(:pusher_user)} " \
+      "in #{elapsed} seconds."
+    }
+    set :pusher_deploy_started_text, -> {
+      "#{fetch(:stage)} deploy started with revision/branch #{fetch(:current_revision, fetch(:branch))} for #{fetch(:application)}"
+    }
+    set :pusher_deploy_failed_text, -> {
+      "#{fetch(:stage)} deploy of #{fetch(:application)} with revision/branch #{fetch(:current_revision, fetch(:branch))} failed"
+    }
+
+### Copyright
+
+Copyright (c) 2014 OnTheBeach Ltd. See LICENSE.txt for
+further details.

data/Rakefile

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

data/capistrano-pusher.gemspec

@@ -0,0 +1,25 @@
+# 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-pusher'
+  spec.version       = '1.0.0'
+  spec.authors       = ['seenmyfate']
+  spec.email         = ['seenmyfate@gmail.com']
+  spec.summary       = %q{Publish deployment notifications to Pusher}
+  spec.description   = %q{Publish deployment notifications to Pusher}
+  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_runtime_dependency 'pusher'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/capistrano/push.rb

@@ -0,0 +1,15 @@
+require 'pusher'
+module Capistrano
+  class Push
+
+    def initialize(url, channel)
+      @url, @channel = url, channel
+    end
+
+    def trigger(state, payload)
+      Pusher.url = @url
+      Pusher[@channel].trigger(state, payload)
+    end
+
+  end
+end

data/lib/capistrano/pusher.rb

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

data/lib/capistrano/tasks/pusher.cap

@@ -0,0 +1,70 @@
+namespace :pusher do
+  desc 'Notify Pusher of a deployment - :pusher_url must be set'
+  task :notify_started do
+    run_locally do
+      info 'Notifying Pusher of started deploy'
+      set :time_started, Time.now.to_i
+      set :pusher_message, fetch(:pusher_deploy_started_text)
+      set :pusher_state, :started
+      Capistrano::Push.new(fetch(:pusher_url), fetch(:pusher_channel)).
+        trigger(fetch(:pusher_state), fetch(:pusher_payload))
+    end
+  end
+  before 'deploy:starting', 'pusher:notify_started'
+
+  desc 'Notify Pusher of a deployment - :pusher_url must be set'
+  task :notify_finished do
+    run_locally do
+      info 'Notifying Pusher of completed deploy'
+      set :time_finished, Time.now.to_i
+      set :pusher_message, fetch(:pusher_deploy_finished_text)
+      set :pusher_state, :finished
+      Capistrano::Push.new(fetch(:pusher_url), fetch(:pusher_channel)).
+        trigger(fetch(:pusher_state), fetch(:pusher_payload))
+    end
+  end
+  after 'deploy:finished', 'pusher:notify_finished'
+
+  desc 'Notify Pusher of a deployment failure - :pusher_url must be set'
+  task :notify_failed do
+    run_locally do
+      info 'Notifying Pusher of failed deploy'
+      set :time_finished, Time.now.to_i
+      set :pusher_message, fetch(:pusher_deploy_failed_text)
+      set :pusher_state, :failed
+      Capistrano::Push.new(fetch(:pusher_url), fetch(:pusher_channel)).
+        trigger(fetch(:pusher_state), fetch(:pusher_payload))
+    end
+  end
+  after 'deploy:failed', 'pusher:notify_failed'
+end
+
+namespace :load do
+  task :defaults do
+    set :pusher_channel, 'capistrano'
+    set :pusher_user, ENV['GIT_AUTHOR_NAME']
+    set :pusher_payload, -> {
+      {
+        message: fetch(:pusher_message),
+        user: fetch(:pusher_user),
+        application: fetch(:application),
+        revision: fetch(:current_revision),
+        branch: fetch(:branch),
+        stage: fetch(:stage),
+        state: fetch(:pusher_state)
+      }
+    }
+    set :pusher_deploy_completed_text, -> {
+      elapsed = Integer(fetch(:time_finished) - fetch(:time_started))
+      "Revision #{fetch(:current_revision, fetch(:branch))} of " \
+        "#{fetch(:application)} deployed to #{fetch(:stage)} by #{fetch(:pusher_user)} " \
+        "in #{elapsed} seconds."
+    }
+    set :pusher_deploy_started_text, -> {
+      "#{fetch(:stage)} deploy started with revision/branch #{fetch(:current_revision, fetch(:branch))} for #{fetch(:application)}"
+    }
+    set :pusher_deploy_failed_text, -> {
+      "#{fetch(:stage)} deploy of #{fetch(:application)} with revision/branch #{fetch(:current_revision, fetch(:branch))} failed"
+    }
+  end
+end

data/spec/lib/capistrano/push_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'capistrano/push'
+
+module Capistrano
+
+  describe Push do
+    let(:pusher) { Push.new(pusher_url, pusher_channel) }
+    let(:pusher_url) { 'http://abc:123@api.pusherapp.com/apps/0' }
+    let(:pusher_channel) { 'capistrano' }
+
+    describe '.new' do
+      it 'takes a url and a channel' do
+        expect(pusher)
+      end
+    end
+
+    describe '#trigger' do
+      let(:channel) { instance_double('Pusher::Channel') }
+      let(:pusher_payload) { double }
+      let(:pusher_state) { double }
+
+      it 'delegates to Pusher' do
+        expect(Pusher).to receive(:[]).with(pusher_channel).and_return(channel)
+        expect(channel).to receive(:trigger).with(pusher_state, pusher_payload)
+
+        pusher.trigger(pusher_state, pusher_payload)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+RSpec.configure do |rspec|
+  rspec.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-pusher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- seenmyfate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pusher
+  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.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: 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 Pusher
+email:
+- seenmyfate@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-pusher.gemspec
+- lib/capistrano-pusher.rb
+- lib/capistrano/push.rb
+- lib/capistrano/pusher.rb
+- lib/capistrano/tasks/pusher.cap
+- spec/lib/capistrano/push_spec.rb
+- spec/spec_helper.rb
+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.2
+signing_key: 
+specification_version: 4
+summary: Publish deployment notifications to Pusher
+test_files:
+- spec/lib/capistrano/push_spec.rb
+- spec/spec_helper.rb