capistrano-graphite 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2217bead0988be425af65e7a8840eaf056c1fb67
-  data.tar.gz: 90c899ecd01b2033fd072e3a589407560401841c
+  metadata.gz: 2c337353592f855999c6be4c8db8599556225dfb
+  data.tar.gz: 9a654504efff0eb61d7a25fbe95280f76d6d0710
 SHA512:
-  metadata.gz: db30fbfa0227b4ca9a4dcc7f40a1a87abb5c56beac82f2fc4e209f8a9461c4e8536bd7a11a871b5e9672e9890494040ce9ff57ce48f7b7c05f5a75f0dc31d057
-  data.tar.gz: 55e261bd872065efb84473fbabcaeb8efd7503050bdad9b9e0ff93de44376177c8e0a9ea0f1faabb859b6b68d946b5b9ad28f19e695dafcc0d8eb6747c191118
+  metadata.gz: ca92e6af6cd0905bc516d4fa47c2604486187e7759ae10b72a0b5d82410deec18d0a4dcaa0835d6bf415ed7692870e4802cc0daeae63652ad43683b6822c8648
+  data.tar.gz: 55162d1d21751b205ed8362f9265476b4d560f56e7d47203fd719ab9ddf767f8bceb78ce4139d6674dabc1ebfb4995c4650a47d075ade22ed59e2e723913008b

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/README.md

@@ -2,16 +2,18 @@
 [![Gem Version](http://img.shields.io/gem/v/capistrano-graphite.svg)][gem]
 [![Build Status](http://img.shields.io/travis/scottsuch/capistrano-graphite.svg)][travis]
 [![Dependency Status](http://img.shields.io/gemnasium/scottsuch/capistrano-graphite.svg)][gemnasium]
+[![Coverage Status](http://img.shields.io/coveralls/scottsuch/capistrano-graphite.svg)][coveralls]
 [![Code Climate](http://img.shields.io/codeclimate/github/scottsuch/capistrano-graphite.svg)][codeclimate]
 
 [gem]: https://rubygems.org/gems/capistrano-graphite
 [travis]: http://travis-ci.org/scottsuch/capistrano-graphite
 [gemnasium]: https://gemnasium.com/scottsuch/capistrano-graphite
+[coveralls]: https://coveralls.io/r/scottsuch/capistrano-graphite
 [codeclimate]: https://codeclimate.com/github/scottsuch/capistrano-graphite
 This gem works with Capistrano v3.1.0 and above and was based off the work on [this gem](https://github.com/hellvinz/graphite-notify) which works with Capistrano v2.x.
 
-Adding this gem to [Capistrano](https://github.com/capistrano/capistrano) deploy extends functionality by pushing events to graphite.
-Currently events are only pushed after ```deploy:updated``` and ```deploy:reverted```.
+Adding this gem to [Capistrano](https://github.com/capistrano/capistrano) extends functionality by pushing events to graphite upon deployment and rollback.
+Currently events are only pushed after `deploy:updated` and `deploy:reverted`.
 
 Some information on events can be found in [this article](http://obfuscurity.com/2014/01/Graphite-Tip-A-Better-Way-to-Store-Events).
 
@@ -30,7 +32,7 @@ And then execute:
 
 ## Usage
 ### Setup your application
-Add the following line to your ```Capfile```.
+Add the following line to your `Capfile`.
 
     require "capistrano/graphite"
 
@@ -39,9 +41,12 @@ Path to your graphite instance. Port and user:password are optional.
 
     set: :graphite_url, "http://user:password@example.com:8000/events/"
 
-Disable sending events for a particular stage by setting the following to 0
+Disable sending events for a particular stage by setting the following to 0.
+Note that the config `graphite_enable_events` has been deprecated in favor of
+the config `suppress_graphite_events` below
+
+    set :suppress_graphite_events, "true"      # This is set to false by default
 
-    set :graphite_enable_events, 0      # This is set to 1 by default
 
 ### Test that it's working
 You can run the following on it's own assuming you have configured the graphite url

data/capistrano-graphite.gemspec

@@ -3,28 +3,35 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'capistrano/graphite/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "capistrano-graphite"
-  spec.version       = Capistrano::Graphite::VERSION
-  spec.authors       = ["scottsuch"]
-  spec.email         = ["sgorsuch@gmail.com"]
-  spec.summary       = %q{A gem for pushing graphite events via capistrano v3
-                          deployment}
-  spec.description   = %q{This gem plugs into the deploy task in capistrano to
-                          help provide visibility into when deployments and
-                          rollbacks occured.}
-  spec.homepage      = "https://github.com/scottsuch/capistrano-graphite"
-  spec.license       = "MIT"
+Gem::Specification.new do |s|
+  s.name          = "capistrano-graphite"
+  s.version       = Capistrano::Graphite::VERSION
+  s.authors       = ["scottsuch"]
+  s.email         = ["sgorsuch@gmail.com"]
+  s.summary       = %q{A gem for pushing graphite events via capistrano v3
+                       deployment}
+  s.description   = %q{This gem plugs into the deploy task in capistrano to
+                       help provide visibility into when deployments and
+                       rollbacks occured.}
+  s.homepage      = "https://github.com/scottsuch/capistrano-graphite"
+  s.license       = "MIT"
 
-  spec.required_ruby_version = '> 1.9'
+  s.required_ruby_version = '> 1.9'
 
-  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"]
+  s.post_install_message = "The config `graphite_enable_events` has changed " \
+                           "to `suppress_graphite_events` and will accept " \
+                           "a true or false. See the README.md at" \
+                           "https://github.com/scottsuch/capistrano-graphite " \
+                           "for details.}"\
 
-  spec.add_dependency             "capistrano", "~> 3.0"
-  spec.add_development_dependency "bundler",    "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency             "capistrano", "~> 3.0"
+  s.add_development_dependency "bundler",    "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "coveralls"
 end

data/lib/capistrano/graphite.rb

@@ -4,21 +4,7 @@ require 'uri'
 require 'sshkit'
 require 'sshkit/dsl'
 
-set :local_user, ENV['USER']
-
 class GraphiteInterface
-  def self.events_enabled(action)
-    if fetch(:graphite_enable_events).to_i == 1
-      # We only post an event if graphite_enable_events was set to 1
-      GraphiteInterface.new.post_event(action)
-      return 1
-    elsif fetch(:graphite_enable_events).to_i == 0
-      return 0
-    else
-      return -1
-    end
-  end
-
   def post_event(action)
     uri = URI::parse("#{fetch(:graphite_url)}")
     req = Net::HTTP::Post.new(uri.path)
@@ -32,41 +18,33 @@ class GraphiteInterface
 end
 
 namespace :deploy do
-  desc 'notify graphite that a deployment occured'
-  task :graphite_deploy do
+  desc 'Post an event to graphite'
+  task :post_graphite, :action do |t, args|
+    action = args[:action]
     on roles(:all) do |host|
-      action = "deploy"
-      if GraphiteInterface.events_enabled(action) == 1
+      if fetch(:suppress_graphite_events).downcase == "true"
+        GraphiteInterface.new.post_event("#{action}")
         info("#{action.capitalize} event posted to graphite.")
-      elsif GraphiteInterface.events_enabled(action) == 0
-        info("No event posted: graphite_enable_events set to 0.")
+      elsif fetch(:suppress_graphite_events).downcase == "false"
+        info("No event posted: `suppress_graphite_events` set to true.")
       else
-        warn("No event posted: graphite_enable_events set to invalid variable.")
-      end
-    end
-  end
-
-  desc 'notify graphite that a rollback occured'
-  task :graphite_rollback do
-    on roles(:all) do |host|
-      action = "rollback"
-      if GraphiteInterface.events_enabled(action) == 1
-        info("#{action.capitalize} event posted to graphite.")
-      elsif GraphiteInterface.events_enabled(action) == 0
-        info("No event posted: graphite_enable_events set to 0.")
-      else
-        warn("No event posted: graphite_enable_events set to invalid variable.")
+        warn("No event posted: `suppress_graphite_events` set incorrectly.")
       end
     end
   end
 
   # Set the order for these tasks
-  after 'deploy:updated', 'deploy:graphite_deploy'
-  after 'deploy:reverted', 'deploy:graphite_rollback'
+  after 'deploy:updated', 'post_graphite_deploy' do
+    Rake::Task['deploy:post_graphite'].invoke 'deploy'
+  end
+  after 'deploy:reverted', 'post_graphite_rollback' do
+    Rake::Task['deploy:post_graphite'].invoke 'rollback'
+  end
 end
 
 namespace :load do
   task :defaults do
-    set :graphite_enable_events, 1
+    set :suppress_graphite_events, "false"
+    set :local_user, ENV['USER']
   end
 end

data/lib/capistrano/graphite/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Graphite
-    VERSION = "0.3.1"
+    VERSION = "1.0.0"
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'rake'
+require 'capistrano/all'
+require 'capistrano/framework'
+require 'capistrano/setup'
+
+require 'coveralls'
+Coveralls.wear!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-graphite
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - scottsuch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -66,16 +66,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: |-
   This gem plugs into the deploy task in capistrano to
-                            help provide visibility into when deployments and
-                            rollbacks occured.
+                         help provide visibility into when deployments and
+                         rollbacks occured.
 email:
 - sgorsuch@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -85,12 +100,14 @@ files:
 - capistrano-graphite.gemspec
 - lib/capistrano/graphite.rb
 - lib/capistrano/graphite/version.rb
-- spec/README.md
+- spec/spec_helper.rb
 homepage: https://github.com/scottsuch/capistrano-graphite
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: The config `graphite_enable_events` has changed to `suppress_graphite_events`
+  and will accept a true or false. See the README.md athttps://github.com/scottsuch/capistrano-graphite
+  for details.}
 rdoc_options: []
 require_paths:
 - lib
@@ -111,5 +128,5 @@ signing_key:
 specification_version: 4
 summary: A gem for pushing graphite events via capistrano v3 deployment
 test_files:
-- spec/README.md
+- spec/spec_helper.rb
 has_rdoc: 

data/spec/README.md

@@ -1 +0,0 @@
-TODO: Add test